JPMorgan Chase Payment Initiation 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 Initiation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
1 operation
across 1 path,
and defines 75 schemas.
It is described by OpenAPI 3.2.0, at version 1.2.3.
Requests are made against 5 base URLs: https://apigateway.jpmorgan.com/tsapi/v1, https://api-mtls.merchant.jpmorgan.com/tsapi/v1, https://apigatewaycat.jpmorgan.com/tsapi/v1, https://apigatewaycat-pci.jpmorgan.com/tsapi/v1, https://api-mock.payments.jpmorgan.com/tsapi/v1.
The identity and technical contract details declared by the specification.
Payments
object
19 properties
8 required
OrganizationId
object
Collection of registration information held against the party. It can be used when the underlying payer is a Legal Entity.
4 properties
DebtorAgent
object
2 properties
1 required
Error
object
2 properties
PaymentIdentifiers
object
Payment Id
2 properties
1 required
DebtorAlternateAccountIdentification
object
3 properties
1 required
AccountType
string
- Mandatory for SEPA Instant - Use IBAN - Mandatory for Blockchain Payments (Kinexys Digital Payments)- DDA, BDA (Blockchain Deposit Account) - Field not appli…
CountryOfResidence
string
2 character ISO country code of residence. Mandatory for Interac payments.
AccountIdentification
string
Maximum length supported for each instrument and market :- | Market |Maximum length limits| | ------ |--------------------------| | US RTP |9 (Routing and Tran…
CoreInitiatingParty
object
Initiating party details
1 property
1 required
OrganizationID
object
Can be used when the underlying payer is a Legal Entity. It should be used together with Ultimate Debtor Name and address, and it should contain the payment ac…
4 properties
1 required
AccountCurrency
string
Originator account currency in 3 character ISO currency code. Field not applicable to Alternate Payments (Cards) UK FPS - GBP only SEPA INSTANT - EUR only
IndividualID
object
Can be used if the organizationID is not populated, when the underlying payer is an Individual. It should be used together with UltimateDebtorName and address,…
3 properties
1 required
CreditorFinancialInstitutionId
object
Financial institution identifier of creditor. For Mexico RTP use either bic or clearingSystemId for a bank transfer use case. Length supported 8 or 11
2 properties
Callbacks
array
List of Error codes and Rule definitions. errorDescription is dynamically generated hence not shown here. | Error Code | Rule Definition | |-------------------…
AlternateAccountIdentifier
string
Alternate Account Identifier eg. email, program id, card number or other types of identifiers, used as a different means of identifying an account. Mandatory f…
AccountTypeEnum
string
Mandatory for : 1. Card Payments 2. Venmo/PayPal wallets 3. Interac 4. India IMPS 6. Malaysia RTP (Credit Transfer & Direct Debit) 8. Brazil RTP (Pay to accoun…
Proprietary
string
Usage rules :- Australia RTP - For AU Superannuation payment (category payment), populate "USI" SEPA Instant - Use value "LEI" to indicate the organization id…
CategoryPurpose
object
Mandatory RTP markets :- Hong Kong - Mandatory
2 properties
PaymentRedirected
object
Object capturing details of a payment that has been redirected to another account Applicable to UK FPS
3 properties
PaymentInitiationResponse
object
1 property
DeviceInfo
object
Contains Creditor device info. Applicable for Direct Debit Payments Only(transferType=DEBIT) Refer the table below for the applicable and mandatory markets | M…
2 properties
ErrorsInit
object
2 properties
AdditionalInstitution
object
Only applicable to UK Faster Payments and Mexico RTP (foreign remittances)
4 properties
Creditor
object
9 properties
1 required
UltimateDebtorIndividual
object
ultimate debtor individual party details
6 properties
1 required
AccountId
string
Direct Debit Payments | Payment Type | Market | Max Length | | -------------| -------- | ---------- | | RTP | Malaysia | 34 | --- Credit Transfer Payments Appl…
StructuredInformation
object
5 properties
AdditionalIdentifier
object
4 properties
2 required
OrganizationIdentification
object
Organization Identification Schemes
1 property
CreditorAgent
object
- Not applicable for Push To Card, Push To Wallet, Zelle and Interac - Mandatory for pay by account and optional for pay by proxy. - Mandatory for Mexico RTP i…
2 properties
1 required
AdditionalAlternateAccountIdentifiers
array
One or more values that can be used as alternative identifiers for an account.
IndividualId
object
Can be used if organization ID is not populated, when the underlying payer is an Individual.
3 properties
IndividualIdentification
object
Individual Identification Schemes
1 property
PaymentInitationDetails
object
1 property
1 required
AdditionalAlternateAccountIdentifier
object
A value that can be used as an alternative identifier for an account. - Each identifier entry MUST identify its context as assigned by the associated acount pl…
3 properties
2 required
DebtorFinancialInstitutionId
object
Financial institution identifier of debtor
2 properties
DeliveryDetails
object
2 properties
SchemeName
object
Mandatory - Alternate Payments :- Push To Wallet (PayPal/Venmo/Zelle) Mandatory for pay by proxy - RTP :- Singapore, Australia, Hong Kong, Malaysia, Brazil, Me…
1 property
InitiatingParty
The initiating Party
DebtorAccountIdentification
object
3 properties
1 required
UltimateDebtorOrganization
object
ultimate debtor organization party details
6 properties
1 required
ErrorDetails
object
3 properties
AdditionalCreditor
object
1 property
Decimal
string
A String representation of a (potentially) decimal positive number.
UltimateCreditorName
string
Mandatory for US RTP & US FedNow
DateAndPlaceOfBirth
object
3 properties
UltimateCreditorOrganization
object
ultimate creditor organization party details
5 properties
1 required
AlternateAccountIdentification
object
5 properties
1 required
DebtorDevice
object
Applicable and mandatory for Malaysia Faster Payments
1 property
UltimateCreditorIndividual
object
ultimate creditor individual party details
5 properties
1 required
AdditionalParties
object
Additional parties involved in the money movement.
1 property
Purpose
object
This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between…
2 properties
PostalAddress
object
Address of the party - For UK FPS it is recommended that the combined length of all structured fields should be less than 140 characters - SEPA Instant : - cre…
8 properties
IdType
string
Credit Transfer Payment Creditor Agent - Applicable and optional for Low value ACH payments (Chile). Applicable and mandatory for US RTP - USABA Debtor Agent -…
FxApplied
object
1 property
Debtor
object
5 properties
1 required
PrimaryAccountIdentification
object
4 properties
1 required
SecureVerification
object
2 properties
RemittanceInformation
object
Mandatory for Malaysia Faster Payments, optional for other markets
4 properties
TaxInformation
object
mandatory for Brazil PIX and Chile Low value ACH payments Optional for Mexico RTP
3 properties
PaymentType
string
Mandatory for RTP, ACH payments and and Kinexys Digital Payments. To Specify the payment type, use: - RTP for Faster Payments - ACH.TRF for Chile ACH Payments…
UltimateDebtorName
string
- Mandatory for US RTP Market specific maximum length limits :- | Market |Maximum Length| |----------------- |----| | Push To Card| 25 |
ServiceLevelCode
string
service Level in coded form.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
