JPMorgan Chase Payments API
API to initiate payments
JPMorgan Chase Payments 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 Payments. 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 136 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 7 base URLs: https://api.payments.jpmorgan.com/payment/v2, https://api-mock.payments.jpmorgan.com/payment/v2, https://api-sandbox.payments.jpmorgan.com/payment/v2, https://apigateway.jpmorgan.com/tsapi/paybybank/v2, https://apigatewayqaf.jpmorgan.com/tsapi/paybybank/v2, https://apigatewaycat.jpmorgan.com/tsapi/paybybank/v2, https://api-mock.payments.jpmorgan.com/tsapi/paybybank/v2.
5 operations
4 paths
136 schemas
3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
JPMorgan Chase Payments API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Payments 5
API to initiate payments
POST
/payments
Initiate Payments
GET
/payments
Query Payments by endToEndId or paymentId
GET
/payments/{paymentId}
Retrieve Payment by paymentId
POST
/payments/{id}/acknowledge
Acknowledge Payments
GET
/payments/{id}
Retrieve Payments
Schemas 136
The contract defines 136 schemas that model the data the API accepts and returns. The most detailed are Payment (21 properties), PaymentReadOnlyView (21 properties), Address (16 properties), PaymentStatus (14 properties). Each schema is shown below with its type and property counts.
ChargesInformation
object
Information regarding the charge bearer and the relevant charges
2 properties
UnstructuredInformation
object
Unstructured remittance information
2 properties
BirthDate
object
Date of Birth
1 property
OtherPaymentReferences
object
Other Payment Reference Identifiers
2 properties
AdditionalContext
array
Additional details about the error based on a standard (e.g. ISO or Clearing codes)
PaymentDetails
object
A collection of payment details.
1 property
Event
object
Event Notification Data Common Component
7 properties
6 required
SignedContent
string
A JWS (JSON Web Signature) Compact Serialization string with an attached payload. JWS is a [JOSE specification](https://jose.readthedocs.io/en/latest/) that de…
IndividualIdentification
object
Individual Identification Schemes
1 property
1 required
UnstructuredAddress
array
Unstructured Addresses
FxInformationReadOnly
object
Provides information on foreign exchange details
5 properties
UltimateParty
object
The Ultimate Party (Ultimate Creditor or Ultimate Debtor)
8 properties
Error
object
Common Error Model
5 properties
1 required
AdditionalInstitutions
array
Additional Institutions: - Applicable to UK RTP and Mexico RTP (foreign remittances)
TransferType
string
Indicates the direction of the money movement. The transaction is either a credit push transfer or a direct debit pull transfer. Supported values:- | Market/In…
CreditorPrivateId
object
Private Party Identification of a Creditor within the context of a mandate amendment
2 properties
SettlementAccountDetails
object
Settlement Account Details
4 properties
1 required
EndToEndId
string
Customer assigned Unique identifier to unambiguously identify the Payment transaction. This identification is passed on, unchanged, throughout the entire end-t…
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
PaymentIdentifiers
object
Identifiers associated with the Payment Instruction throughout its lifecycle.
2 properties
1 required
PaymentType
string
The type of payment being initiated Use: - RTP for Realtime Payments - ACH for ACH Payments - BLOCKCHAIN for payments via Kinexys Digital Payments - WIRE for W…
FinancialInstitutionIdType
string
View
string
PaymentReadOnlyView
object
Representation of the payment instruction.
21 properties
4 required
RegulatoryReporting
object
Regulatory reporting information
2 properties
RemittanceInformation
object
Mandatory for Malaysia NPP Payments, optional for other markets
5 properties
PaymentStatusBasic
object
Representation of the basic payment status
9 properties
3 required
TransactionIdentifier
string
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entir…
IsoCountryCode
string
ISO 3166-1 Alpha-2 Country Code
PaymentIdentifiersReadOnly
object
Identifiers associated with the Payment Instruction throughout its lifecycle.
4 properties
1 required
MandateInformation
object
Mandate related information. Applicable to the following Direct Debit markets: | Market | |----------| | SG | | AU | | MY | | UK | | SEPA |
5 properties
AgentInstructions
array
Instructions for party agents(Creditor, Debtor or additional parties)
SequenceType
string
Signals the nature of a payment within a series for a direct debit collection. |Sequence Type | Description | |--------------|---------------------------------…
InitiatingParty
object
The initiating Party
5 properties
IdempotencyKey
string
A unique string that enables the API support idempotency by safely retrying requests without accidentally performing the same operation twice.
AdditionalCreditor
object
Additional creditor parties. - To support RTP payment flows for TP4, TP5 & TPx use cases.
7 properties
1 required
AlternateAccountIdentifiers
array
One or more values that can be used as alternate identifiers for an account.
SettlementInformation
object
Settlement Account Information
2 properties
TaxEntry
object
Tax entry details
4 properties
FxInformation
object
Provides information on foreign exchange details
4 properties
Value
object
Amount Value in a given currency.
2 properties
2 required
PaymentDetail
Payment Detail
Fx
object
Foreign Exchange Information
1 property
IntermediaryAgent
object
An agent between the debtor's agent and the creditor's agent. Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the age…
4 properties
DebtorFinancialInstitutionId
object
Debtor FinancialInstitution Id
3 properties
2 required
DeliveryMethod
string
Method used to deliver the remittance advice information The following methods are allowed | Code | Description | |------|----------------------------------| |…
IsoCurrencyCode
string
ISO 4217 Alpha-3 Currency Code
OtherPaymentReferencesReadOnly
object
Other Payment Reference Identifiers
3 properties
OrganizationId
object
Collection of registration information held against the party. It can be used when the underlying payer is a Legal Entity. It should be used together with Ulti…
4 properties
1 required
StructuredInformation
object
Structured Remittance Information
7 properties
OrganizationIdentification
object
Organization Identification Schemes
1 property
1 required
AmountValue
object
Instructed Amount Value in a given currency.
2 properties
2 required
EquivalentValue
object
Amount of money to be moved between debtor and creditor, before deduction of charges, expressed in the currency of the debtor's account, and to be moved in a d…
1 property
1 required
PrimaryAccountDetailsPreviousInstructingAgent
object
Primary account details of the previous instructing agent
4 properties
1 required
Decimal
string
A String representation of a (potentially) whole number or decimal positive number. - Amount should be more than 0.01 with maximum of two decimal places allowe…
PaymentEvent
object
Payment Event Data
1 property
1 required
SecureVerification
object
Secure verification object containing key and secret for authentication
2 properties
AlternateAccountDetails
object
Alternate Account Details
1 property
1 required
AlternateAccountIdentifier
object
- Alternate Account Identifier eg. email, program id, proprietary. - Mandatory for Push To Card: - Use program id while specifying the identifier for debtor de…
3 properties
2 required
Webhook
object
Representation of a Webhook Event
PaymentValue
object
Payment value
RequestId
string
Client provided unique identifier for the current request invocation
CardAccountDetails
object
Card Account Identifier, mandatory for Push to Card(P2C). - To be used while specifying the account identifier for creditor details
1 property
1 required
PaymentPurpose
object
The Payment's purpose
2 properties
ErrorContext
object
Error Context
5 properties
1 required
LocalInstrument
object
Specifies a user community specific instrument
2 properties
UltimateDebtorAccount
VatBranchCode
string
VAT Branch Code
StandardCodeContext
object
Schema representing a standard code context such as ISO or Clearing codes
3 properties
3 required
Payment
object
Representation of the payment instruction.
21 properties
8 required
ContactDetails
object
Party contact details
8 properties
PaymentRedirection
object
Represents details of a payment that has been redirected to another bank account Applicable only for UK FPS
2 properties
2 required
CreditorAgent
object
The Bank or financial institution of the creditor(the party receiving the payment) - Not applicable for Push To Card, Push To Wallet and Interac - Mandatory fo…
4 properties
1 required
TaxInformation
object
Mandatory for Brazil PIX (Pay To Account scenario), Thailand PromptPay (e-WHT) and Chile Low value ACH payments Optional for Mexico RTP - Tax Amount is only ap…
5 properties
CategoryPurpose
object
Specifies the high level purpose of the payment based on a set of pre-defined categories.
2 properties
BasicAddress
object
Address type
3 properties
IsoCountrySubdivisionCode
string
ISO 3166-2 Alphanumeric Country Subdivision Code
DeviceInfo
object
Device details of a party partaking in the money movement. Applicable and mandatory for Malaysia NPP Payments. Refer the table below for the applicable and man…
2 properties
PaymentId
string
Unique payment initiation identification number
Address
object
Representation of an Address
16 properties
AdditionalInstitution
object
Only applicable to UK Faster Payments and Mexico RTP (foreign remittances)
5 properties
2 required
DeliveryDetails
object
Details of the delivery method and address for remittance information
2 properties
AccountId
string
This field captures a regular account number . Maximum length supported for different instruments and markets: | Market/Instrument | Maximum length limits | |-…
PaymentInitiationDuplicateResponse
object
Duplicate payment
3 properties
2 required
DebtorAccountType
string
Mandatory for SEPA Instant - Use IBAN Mandatory for Blockchain Payments - DDA, BDA (Blockchain Deposit Account) Field not applicable to Alternate Payments (Wal…
Account
Representation of a bank account. Features of the model may vary between different account types.
CreditorFinancialInstitutionId
object
Creditor Financial InstitutionId
3 properties
2 required
AdditionalCreditorFinancialInstitutionId
object
Additional Creditor FinancialInstitution Id
3 properties
2 required
RateDecimal
string
A String representation of a (potentially) decimal positive rate value.
ClearingSystem
object
Details of the clearing system used to process the payment instruction
2 properties
PaymentContext
string
Specifies the context of the payment flow: - WIRES Specific payment context: |Payment Context | description |-----------------|----------------- |FI | Financia…
CreditorTaxInformation
object
Creditor Tax Information
3 properties
1 required
IndividualId
object
Can be used if organization ID is not populated, when the underlying payer is an Individual. It should be used together with Ultimate Debtor Name and address,…
3 properties
1 required
Invoicee
object
Invoicee party identification
5 properties
DebtorAlternateAccountDetails
object
Alternate account details
3 properties
1 required
PaymentStatus
object
Representation of the payment status
14 properties
7 required
PreviousInstructingAgentFinancialInstitutionId
object
Previous Instructing Agent Financial Institution Id
3 properties
2 required
DebtorAccountId
string
Applicable and mandatory for RTP, ACH, Wires and Blockchain (Kinexys) Payments only This field is to provide the regular account number when it is a pay by Acc…
DebtorAccountDetails
object
Primary account details
4 properties
1 required
AmountDecimal
string
A String representation of a (potentially) whole number or decimal positive number. - Amount should be more than 0.01 with maximum of two decimal places allowe…
DateAndPlaceOfBirth
Date and place of birth.
DebtorTaxInformation
object
Debtor Tax Information
3 properties
1 required
Party
object
Party
8 properties
1 required
Invoicer
object
Invoicer party identification
5 properties
PreviousInstructingAgent
object
Agent that previously handled the payment instruction. Usage: If more than one previous instructing agent is present, then position must be used to represent t…
6 properties
1 required
PaymentInitiationResponse
object
Representation of the Payment initiation response
9 properties
7 required
PaymentEventData
object
Representation of Payment Event Data
1 property
AdditionalParties
object
Additional parties involved in the money movement.
7 properties
DebtorAgent
object
Debtor Agent
4 properties
PaymentTypeInformation
object
A set of coded elements that further specifies the type of Payment
4 properties
PartyId
Party Identification
ClearingSystemClientVersion
object
Clearing system used for the payment. The clearing system is a network that facilitates the transfer of funds between banks or financial institutions. It acts…
1 property
AccountType
string
Mandatory for : - India IMPS - Malaysia NPP - Brazil RTP (Pay to account only) - Blockchain Payments - US ACH (IAT and NON IAT) India IMPS: - LOAN - Loan accou…
PrimaryAccountDetails
object
Account Details
4 properties
1 required
ErrorContext_2
object
4 properties
1 required
ISOCurrencyCode
string
Currency of the money movement: a 3 alpha character ISO 4217 currency code.
AccountIdType
string
The account identifier type
ProviderName
string
Optional name of a pre-selected Provider (sourced from the providers list). Providing this field will skip the bank selection screen for the end-user using the…
PaymentAmount
object
The amount value and currency of a payment amount should be more than 0.01 with maximum of two decimal places allowed. Payment amount limits vary depending upo…
2 properties
2 required
StatusUpdatedAt
string
The last updated date and time of the status, in ISO 8601 format.
Value_2
string
The value representation of a monetary amount. The amount value should be more than 0.01 with maximum of two decimal places allowed.
Error_2
object
The error object returned by the API.
5 properties
1 required
PaymentResponseMetadata
object
8 properties
Debtor
object
The party that pays for goods and services or sends funds. The debtor IBAN can be prefilled by the payment initiator: - If prefilled, the user will not be allo…
PaymentId_2
Reference
string
A free text field that can be used to provide a meaningful reference for a payment transaction
Market
string
ISO 3166-1 alpha-2 country code for the market where the payment is initiated. - Market Coverage: DE, ES, GB, IT
AccountId_2
string
Debtor account number as identified by the bank or financial institution. Maximum length supported for each instrument and market. Refer to the table below | M…
PaymentType_2
string
The type of payment. List of supported payment types, their usage and categorization by region: Payment Type | Description -------------------------|----------…
Creditor
object
The recipient of funds in the context of a payment.
2 required
PaymentResponse
Party_2
object
Representation of a Sender or Recipient of funds within the context of a payment.
2 properties
Account_2
object
Captures account information
2 properties
2 required
Payments
object
8 properties
5 required
Name
string
Name
UniqueResourceIdentifier
string
An immutable opaque string that uniquely identifies a resource.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from JPMorgan Chase 12
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
#Payments
Where this information came from
This is an independent, third-party profile of JPMorgan Chase Payments 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.