How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

JPMorgan Chase Payment Request API

Manage Payment Requests

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.

5 operations 4 paths 56 schemas 1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.4.4
Base URL
https://api.payments.jpmorgan.com/onboarding/v1
Resource Areas
1

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment Request 5

Manage Payment Requests

POST
/payment-requests
Create a Payment Request
createPaymentRequest 1 param body → 201400401403429503
GET
/payment-requests/{id}
Retrieve the Details of a Single Payment Request
retrievePaymentRequest 2 params → 200400401403404429503
PUT
/payment-requests/{id}
Create a Payment Request by Client Id or Update a Payment Request
updatePaymentRequest 2 params body → 200400401403404405412429
POST
/payment-requests/{id}/cancel
Cancel a Single Payment Request
cancelPaymentRequest 1 param body → 200400401403404429503
POST
/payment-requests/search
Retrieve a List of Payment Requests
retrievePaymentRequests body → 200400401403429503

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are PaymentRequest (20 properties), SearchCriteria (17 properties), PaymentRequestDetails (12 properties), Return (10 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jp-morgan-chase-payment-request-api-openapi.yml Raw ↑

Other APIs JPMorgan Chase publishes across the network.

Notifications API
Accounts API
Recipients API
Webhooks API
Transactions API
Documents API
JPMorgan Chase Account Information API
JPMorgan Chase Account Restrictions API
JPMorgan Chase Account Services API
JPMorgan Chase Account Statements API
JPMorgan Chase Account Transactions API
JPMorgan Chase Account Updates API
Where this information came from

This is an independent, third-party profile of JPMorgan Chase Payment Request API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.