JPMorgan Chase Payment Methods API
Payment Methods API
JPMorgan Chase Payment Methods 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 Methods. 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 98 schemas. It is described by OpenAPI 3.2.0, at version 2.4.2.
Requests are made against 3 base URLs: https://profiles-api.merchant.jpmorgan.com/api/v2/mmp, https://cat-profiles-api.merchant.jpmorgan.com/api/v2/mmp, https://api-mock.payments.jpmorgan.com/api/v2/mmp.
5 operations
4 paths
98 schemas
1 DELETE1 GET2 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
JPMorgan Chase Payment Methods API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Payment Methods 5
Payment Methods API
POST
/consumer-profiles/{consumer-profile-id}/payment-methods
Add a new payment method to an existing consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}/default
Update a payment method to default on an existing consumer profile
PATCH
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}
Update a payment method on an existing consumer profile
DELETE
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}
Delete a payment method
GET
/consumer-profiles/{consumer-profile-id}/payment-methods/{payment-method-id}/status
Retrieve 3DS status
Schemas 98
The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are card (23 properties), createCard (23 properties), updatedCard (20 properties), consumerProfileResponse (18 properties). Each schema is shown below with its type and property counts.
middleName
string
That part of an individual's name generally positioned between the first and family names, as a second given name or a maternal surname. (NOTE: in some instanc…
updateAch
object
ACH payment Information
8 properties
consumerProfileIdResponse
object
Consumer Profile Response Object
4 properties
phone
object
Phone Information
4 properties
2 required
sepa
object
Sepa Payment Information
11 properties
state
string
Classifies a geographic area that represents a first level, legal and political subdivision of a country; it should be in the ISO 3166-2 format. For Example: t…
consumerPreferredPaymentNetwork
string
The consumer’s chosen card network to route eligible transactions when multiple networks are available. Valid Values are VI,MC, CB
createTimestamp
string
Designates the hour, minute and second in a specific day when the record was created.
encryptedPayload
string
Encrypted message details have been rendered unreadable by general means through the application of a given set of instructions and a key.
createAch
object
ACH payment Information
13 properties
2 required
cardExpirationMonthYearNumber
string
A number in the form of Month/Year that is displayed on a card (Debit/Credit). This number is used for the date which is no longer in effect for transactions b…
accountStatus
string
Codifies the current status of the card.
consumerAssignedAddressName
string
A short label defined by the consumer that will allow them to refer to the address by name. E.g Home , Office , JohnDoeHome
paymentMethodId
string
Identifies a unique occurrence of the type of payment accepted by a level of the hierarchy of the merchant acquiring account.
responseStatus
string
Request result status.
applepay
object
Use is for encrypted bundles for web or Internet acceptance of digital device wallets such as Apple Pay
2 properties
consumerProfileAddress
object
Address Information used for consumer profile
12 properties
message
string
Provides textual description of a problem that has occurred and which is preventing the system from completing a task. Messages can be a confirmation, warning…
financialInstitutionRoutingNumber
string
Identifies the routing and transit number assigned by an administrative body to formally identify a chartered financial institution (bank) within a given count…
first6CardNumber
string
Identifies the first six digits of the primary account number of a credit, debit or pre-paid card. As of 2017, this does not necessarily align to the Issuer Id…
lastName
string
That part of an individual’s name generally placed at the end of the given name. The last name is also known as the surname or family name. (Note: name convent…
line1
string
A portion of a party's address which is the line of the unstructured (unparsed) geographic street address containing any of the following: house number, street…
createSepa
object
Sepa Payment Information
11 properties
encryptedPaymentHeader
object
Header information used on digital payment methods such as ApplePay, GooglePay and Paze in the Encrypted format.
4 properties
fullName
string
Name of accoundholder business name.
updatedPaymentMethodType
object
Updated Payment Method Type
5 properties
validationMessage
object
Object containing information about transaction validation.
3 properties
2 required
requestId
string
Unique request identifier to track the request through application programming interface(API) .
postalCode
string
The portion of a party’s address that is the encoded representation of a geographic area to facilitate mail delivery services.
addressType
string
Codifies the classification given to the various addresses captured for a party, such as Doing Business As Address, Legal Entity Address, and Tax Address. Vali…
cardBadgeType
string
Codifies the type of card that operate on single payment network or co-badge (more than one network) .Valid values : COBADGED or MONOBADGED
consumerProfileResponse
object
Consumer Profile Response Object
18 properties
firstName
string
That part of an individual's full name considered a personal name or given name and generally positioned before the last name or family name.
ach
object
ACH payment Information
13 properties
2 required
threeDSPurchaseInfo
object
Three DS Purchase Info
2 properties
isBillPayment
boolean
Indicates whether or not the transaction is identified by Visa as a bill payment, prearranged between the cardholder and the merchant.
authenticationId
string
A unique identifier for the card owner authentication provided by a global authentication solution such as Three Domain Secure (3DS) designed to make eCommerce…
updateBacs
object
Update BACS information
7 properties
cardType
string
Codifies the method used to pay for the exchange of money, goods or services between a merchant and their customer such as VI,MC, AX.
merchant
object
Information about the merchant
1 property
addressIdentifier
string
Identifies a classification of a geographic area that is captured for a consumer purchasing goods or services.
last4CardNumber
string
Identifies the final 4 digits of the 16 digit card number. The truncated value is used in place of the full number to protect against exposure of confidential…
accountType
string
Codifies a bank account where funds are deposited or stored (e.g., checking and savings account). When shared with a financial institution as the client's prim…
encryptedPaymentBundle
object
Encrypted Data for digital payment methods such as ApplePay, GooglePay and Paze.
4 properties
code
string
Codifies a raised exception encountered by an internal or external system, sub-system, interface, job, module, or system component with which the web service a…
paze
object
Use is for encrypted bundles for web or Internet acceptance of digital device wallets PAZE
1 property
responseMessage
string
Long explanation of the response message.
threeDSAuthenticatedData
object
Three DS Authenticated Data
4 properties
updateCard
object
Card payment Information
14 properties
createUserIdentifier
string
The identifier (id) of the user who created the object or inserted the row. This could be the Firm’s Standard Identifier, or the identifier of a batch/function…
accountNumberType
string
Specifies the type of payment method used by the account number in payment transaction.
googlepay
object
Use is for encrypted bundles for web or Internet acceptance of digital device wallets such as Google Pay
2 properties
last4AccountNumber
string
Identifies the final 4 digits of the Payment Method Account Number. The truncated value is used in place of the full number to protect against exposure of conf…
consumerUpdatedProfileResponse
object
This is the response payload returned after an update operation.
18 properties
email
object
Email information
3 properties
1 required
bacs
object
Object for BACS (Bankers' Automated Clearing System) is an electronic system payment method make payments directly from one bank account to another. This payme…
11 properties
2 required
messages
object
A list of errors and warnings.
4 properties
2 required
consumerProfileId
string
Identifies a unique occurrence of a consumer's information maintained by the Firm on behalf of the merchant. The consumer profile contains information relevant…
addressStatus
string
Codifies the current status of the profile address.
address
object
Address Object
14 properties
2 required
authenticationResult
object
Cardholder Authentication Result from the Payment request.
3 properties
createDefaultMOP
object
Default payment method
4 properties
primaryAddressIndicator
boolean
Indicates the 'TRUE'/'FALSE' value that represents whether or not an address is the primary address for a given owner
cardAuthenticationDetails
object
Card Authentication Details
7 properties
createPaymentMethod
object
Payment Method Information. Atleast one payment method information should be mandatory
12 properties
responseCode
string
Short explanation of the response code.
updatePaymentMethod
object
Payment Method Object
5 properties
updatedCard
object
Updated card information
20 properties
defaultMOP
object
Default payment method
4 properties
paymentType
string
Identifies how accountholders initiated debits to their accounts .
line2
string
A portion of a party's address which is the line of the unstructured (unparsed) geographic street address containing any of the following: house number, street…
updatedDefaultMOP
object
Updated Default MOP information
4 properties
updateTimestamp
string
Designates the hour, minute, and second in a specifc day when the record was last modified.
paymentMethodType
object
Payment Method Object
5 properties
card
object
Card payment Information
23 properties
1 required
isTransactionMicroEntry
boolean
Indicates the current transaction is an Automated Clearing House (ACH) credit or debit Entry used by an Originator for the purpose of verifying a Receiver’s ac…
createCard
object
Card payment Information
23 properties
1 required
threeDSRequestorAuthenticationInfo
object
Three DS Requestor Authentication Info
2 properties
verificationResult
object
card verification Result
3 properties
accountNumber
string
The card or token number.
adfsError
object
Object containing information about the active directory file system error.
3 properties
3 required
billerDebitCardReferenceNumber
string
The Firm identifier assigned to a debit card number at the instantiation of the debit card number that persists over time as the debit card number changes thro…
countryCode
string
A code that identifies the Country, a Geographic Area, that is recognized as an independent political unit in world affairs. Note: This data element is a child…
profileStatus
string
Codifies the current standing of a Party's profile.
city
string
A portion of a party's address which is the geographic area that is a municipality with legal power granted by a state/province charter.
createBacs
object
Object for BACS (Bankers' Automated Clearing System) is an electronic system payment method make payments directly from one bank account to another. This payme…
11 properties
2 required
consumerProfileUniqueId
string
Identifies a unique occurrence of a consumer's information maintained by the Firm acorss merchant.
updateSepa
object
Sepa Payment Information
7 properties
merchantSoftware
object
Contains information related to the merchant software
3 properties
updateUserIdentifier
string
The identifier (id) of the user who last updated the object or the row. This could be the Firm’s Standard Identifier, or the identifier of a batch/functional p…
authenticationRequest
object
Authentication Request
3 properties
browserInfo
object
Browser Information of the consumer
11 properties
orderOverrideCode
string
Codifies the option merchant has chosen to perform a non-systemic override on a payment order.
mandate
object
This is used for specifying an attribute used on a model for object that will contain one or more attributes
4 properties
3 required
latLong
string
Identifies the latitude and longitude coordinates of the digital device when it is being provisioned. Information is expressed in the order of latitude followe…
profileCardSourceName
string
profileCardSourceName (string, optional): This attribute is to inform if the card is converted card from safetech token or Apple Pay token or network token. ["…
communication
object
Communication Object
4 properties
currency
string
Codifies the monetary unit that was associated with the financial transaction (such as sale, returns, chargebacks etc.).
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
#Payment Methods
Where this information came from
This is an independent, third-party profile of JPMorgan Chase Payment Methods 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.