Request to Pay via QR Code API
Streamline your digital payment experience to create, update, and manage payment requests and payment links, letting your customers pay instantly via shareable QR codes or payment URLs. You can easily track payment status, retrieve payment details, and handle bulk requests, all while integrating with your customers’ financial institutions for secure, real-time transactions.
Request to Pay via QR Code API is one of 26 APIs that JPMorgan Chase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payment Link, Payment Request, and Payment Request - Bulk. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
11 operations
across 8 paths,
organized into 3 resource areas,
and defines 68 schemas.
It is described by OpenAPI 3.0.0, at version 1.4.4.
Requests are made against 3 base URLs: https://api.payments.jpmorgan.com/receivables/request-to-pay/v1, https://api-cat.payments.jpmorgan.com/receivables/request-to-pay/v1, https://api-mock.payments.jpmorgan.com/receivables/request-to-pay/v1.
The identity and technical contract details declared by the specification.
ExpirationType
string
Payment request expiration type |Markets |Description | |:--------------------------|:------------------------------------------------------------------| |Braz…
RequestMethodType
string
Payment Request method type | Value | Description | |:----- |:-----------------------------------------------| |NONE |QR code not required | |QRCODE |Generate…
PageSize
integer
Pagination limit for normal sized payload elements
PaymentLinkId
string
Unique payment link identifier generated by JPM
PaymentLinkAlternateIdentifier
integer
Numeric identifier required by some markets |MARKET | Description | |:------|:------------------------------------------| |BRAZIL | Requires generation of nume…
ISOCountryCode
string
ISO 3166-1 Alpha-2 country code |Markets |Country ISO Code |Description | |:----------|:--------------------|:-------------------------------------------------…
PaymentRequestId
string
Unique transaction identifier provided by client or identifier generated by JPM |Market |Description | |:--------------------------|:--------------------------…
PaymentLink
object
The payment link is a URL hosted at the receiver's PSP. This is invoked by the payer's PSP to retrieve associated QR Code details | Market | Description | |:--…
7 properties
Cursor
object
Pagination cursor
5 properties
3 required
PaymentLinks
object
Contains an array of Payment Link items
2 properties
2 required
ErrorContext
object
Error Context
4 properties
1 required
Error
object
Common error model
5 properties
1 required
PaymentLinkRequest
object
Payment link generation request from client
2 properties
IdempotencyKey
string
A unique string that enables API support idempotency by safely retrying requests without accidentally performing the same operation twice
EndToEndId
string
End to end Id used to identify Payments against a Payment Request |Markets |Description | |:-----------------------------|:------------------------------------…
UnstructuredAddress
array
Unstructured Address |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil | De…
Address
object
Representation of an address
6 properties
Email
object
Representation of an email
2 properties
DebtorTaxInformation
object
Debtor tax details |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Appli…
2 properties
Debtor
object
The person or an entity that pays for the goods or services purchased
4 properties
SchemeName
object
Specifies the type of Proxy account. Mandatory if alternateAccountIdentifier is present
1 property
AlternateAccountIdentifier
string
Alternate account identifier based on the scheme |Markets |Description | |:--------------------------|:--------------------------------------------------------…
AlternateAccountDetails
object
Alternate account details
2 properties
CreditorTaxInformation
object
Creditor tax details |Markets |Description | |:--------------------------|:------------------------------------------------------------------| |Brazil |Applica…
2 properties
Creditor
object
Creditor details
5 properties
Duration
integer
Specify how long (in seconds) the request is valid. ISO 8601 compliant duration. E.g., a validity of 5 minutes will be represented as 300. If duration unspecif…
ExpiresAt
string
Specify a datetime stamp in valid RFC 3339 section 5.6, ISO 8601 compliant format for expiration. E.g., YYYY-MM-DDThh:mm:ss+/-time offset to UTC |Markets |Desc…
ISOCurrencyCode
string
ISO 4217 Alpha-3 Currency Code |Markets |Currency ISO Code |Description | |:----------|:--------------------|:-------------------------------------------------…
Amount
string
The value representation of a monetary amount. The amount value should be more than 0.01 with maximum of two decimal places allowed.
InterestType
string
Interest type |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Applicable…
Percentage
string
The value representation of a percentage. The percentage value should be between 0.01 and 99.99 with maximum of two decimal places allowed
Interest
object
Parameters to calculate interest for the payments overdue |Markets |Description | |:--------------------------|:-----------------------------------------------…
3 properties
DiscountType
string
Discount type |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Applicable…
CutOffItem
object
Cutoff limit to calculate discount, expressed as a date and applicable discount in percentage or fixed amount
3 properties
Discount
object
Parameters to calculate discount based on actual payments |Markets |Description | |:--------------------------|:-----------------------------------------------…
4 properties
ValueType
string
Value type either as fixed amount or percentage of original amount |Markets |Description | |:--------------------------|:--------------------------------------…
Penalty
object
Penalty details expressed as a fixed value or percentage of payment amount |Markets |Description | |:--------------------------|:------------------------------…
2 properties
Reduction
object
Reduction details expressed either as a fixed value or percentage of payment amount |Markets |Description | |:--------------------------|:---------------------…
2 properties
Reference
string
Text to be presented to the payer so that payer can enter related information in free format, to be sent to the recipient. |Markets |Description | |:----------…
UnstructuredInformation
object
Unstructured information about request
2 properties
PaymentRequest
object
Payment Request details
20 properties
1 required
QRCodeRequest
object
Representation of QR Code request
5 properties
NewPaymentRequest
object
New Payment Request
5 properties
3 required
ETag
string
Entity tag that uniquely represents the requested resource represented as string of ASCII characters placed between double quotes e.g., "675af34563dc-tr34". Wi…
RevisionNumber
integer
Payment request revision number
QRCodeImage
object
Representation of QR Code image data
3 properties
QRCodeMetaData
object
QR Code metadata
3 properties
QRCode
Representation of QR Code metadata
Status
string
Payment request and associated QR code status depicting the current status |Value |Description | |:--------------|:--------------------------------------------…
Payment
object
Payment details of Payment Request
9 properties
Return
object
Return details of Payment Request
10 properties
PaymentRequestDetails
object
Payment Request
12 properties
StatusEvent
object
Representation of status change to the payment request
5 properties
PaymentRequestUpdate
object
Payment Request Update Request |Market |Description | |:--------------------------|:------------------------------------------------------------------| |Singap…
4 properties
2 required
CancellationRequest
object
Payment Request cancellation request
2 properties
1 required
CancellationResponse
object
Response to the Payment Request cancellation request
1 property
SearchCriteria
object
Payment Requests search criteria
17 properties
2 required
PaymentRequestCollection
object
Contains an array of Payment Request items
2 properties
2 required
PaymentRequestBulkItem
object
Payment Request
5 properties
3 required
PaymentRequestBulk
object
Bulk Payment Request
2 properties
PaymentRequestBulkId
string
Unique Bulk Payment Requests identifier generated by JPM
BulkPaymentRequestBasic
object
Bulk Payment Request basic details
4 properties
QRCodeGenerationStatus
object
Representation of QR Code generation status
3 properties
BulkStatus
object
Bulk Request Status
2 properties
BulkPaymentRequest
Bulk Payment Request details
PaymentRequestBulkUpdateItem
object
Payment Request Bulk Update Item
4 properties
3 required
PaymentRequestBulkUpdate
object
Bulk Update Payment Requests |Market |Description | |:--------------------------|:------------------------------------------------------------------| |Singapor…
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.