JPMorgan Chase Payment Request API is one of 65 APIs that JPMorgan Chase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payment Request. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
5 operations
across 4 paths,
and defines 56 schemas.
It is described by OpenAPI 3.2.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.
AlternateAccountDetails
object
Alternate account details
2 properties
Error
object
Common error model
5 properties
1 required
PaymentRequest
object
Payment Request details
20 properties
1 required
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
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
Payment
object
Payment details of Payment Request
9 properties
ISOCurrencyCode
string
ISO 4217 Alpha-3 Currency Code |Markets |Currency ISO Code |Description | |:----------|:--------------------|:-------------------------------------------------…
PaymentLinkAlternateIdentifier
integer
Numeric identifier required by some markets |MARKET | Description | |:------|:------------------------------------------| |BRAZIL | Requires generation of nume…
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…
AlternateAccountIdentifier
string
Alternate account identifier based on the scheme |Markets |Description | |:--------------------------|:--------------------------------------------------------…
QRCodeMetaData
object
QR Code metadata
3 properties
Interest
object
Parameters to calculate interest for the payments overdue |Markets |Description | |:--------------------------|:-----------------------------------------------…
3 properties
ErrorContext
object
Error Context
4 properties
1 required
ISOCountryCode
string
ISO 3166-1 Alpha-2 country code |Markets |Country ISO Code |Description | |:----------|:--------------------|:-------------------------------------------------…
PaymentLinkId
string
Unique payment link identifier generated by JPM
Creditor
object
Creditor details
5 properties
PaymentRequestUpdate
object
Payment Request Update Request |Market |Description | |:--------------------------|:------------------------------------------------------------------| |Singap…
4 properties
2 required
PaymentRequestId
string
Unique transaction identifier provided by client or identifier generated by JPM |Market |Description | |:--------------------------|:--------------------------…
UnstructuredInformation
object
Unstructured information about request
2 properties
Penalty
object
Penalty details expressed as a fixed value or percentage of payment amount |Markets |Description | |:--------------------------|:------------------------------…
2 properties
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.
CancellationResponse
object
Response to the Payment Request cancellation request
1 property
InterestType
string
Interest type |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Applicable…
Cursor
object
Pagination cursor
5 properties
3 required
ExpirationType
string
Payment request expiration type |Markets |Description | |:--------------------------|:------------------------------------------------------------------| |Braz…
EndToEndId
string
End to end Id used to identify Payments against a Payment Request |Markets |Description | |:-----------------------------|:------------------------------------…
Email
object
Representation of an email
2 properties
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
SchemeName
object
Specifies the type of Proxy account. Mandatory if alternateAccountIdentifier is present
1 property
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 | |:----------…
QRCodeImage
object
Representation of QR Code image data
3 properties
QRCodeRequest
object
Representation of QR Code request
5 properties
Return
object
Return details of Payment Request
10 properties
RequestMethodType
string
Payment Request method type | Value | Description | |:----- |:-----------------------------------------------| |NONE |QR code not required | |QRCODE |Generate…
IdempotencyKey
string
A unique string that enables API support idempotency by safely retrying requests without accidentally performing the same operation twice
PageSize
integer
Pagination limit for normal sized payload elements
NewPaymentRequest
object
New Payment Request
5 properties
3 required
Reduction
object
Reduction details expressed either as a fixed value or percentage of payment amount |Markets |Description | |:--------------------------|:---------------------…
2 properties
QRCode
Representation of QR Code metadata
DiscountType
string
Discount type |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Applicable…
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…
Status
string
Payment request and associated QR code status depicting the current status |Value |Description | |:--------------|:--------------------------------------------…
SearchCriteria
object
Payment Requests search criteria
17 properties
2 required
CancellationRequest
object
Payment Request cancellation request
2 properties
1 required
Debtor
object
The person or an entity that pays for the goods or services purchased
4 properties
RevisionNumber
integer
Payment request revision number
Address
object
Representation of an address
6 properties
PaymentRequestCollection
object
Contains an array of Payment Request items
2 properties
2 required
CreditorTaxInformation
object
Creditor tax details |Markets |Description | |:--------------------------|:------------------------------------------------------------------| |Brazil |Applica…
2 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…
PaymentRequestDetails
object
Payment Request
12 properties
ValueType
string
Value type either as fixed amount or percentage of original amount |Markets |Description | |:--------------------------|:--------------------------------------…
UnstructuredAddress
array
Unstructured Address |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil | De…
DebtorTaxInformation
object
Debtor tax details |Markets |Description | |:--------------------------|:----------------------------------------------------------------------| |Brazil |Appli…
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.