JPMorgan Chase Communication 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 Communications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
4 operations
across 3 paths,
and defines 71 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.
The identity and technical contract details declared by the specification.
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…
verificationResult
object
card verification Result
3 properties
accountNumber
string
The card or token number.
validationMessage
object
Object containing information about transaction validation.
3 properties
2 required
phone
object
Phone Information
4 properties
2 required
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…
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
requestId
string
Unique request identifier to track the request through application programming interface(API) .
profileStatus
string
Codifies the current standing of a Party's profile.
postalCode
string
The portion of a party’s address that is the encoded representation of a geographic area to facilitate mail delivery services.
messages
object
A list of errors and warnings.
4 properties
2 required
consumerProfileResponse
object
Consumer Profile Response Object
18 properties
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…
sepa
object
Sepa Payment Information
11 properties
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
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
addressStatus
string
Codifies the current status of the profile address.
address
object
Address Object
14 properties
2 required
threeDSRequestorAuthenticationInfo
object
Three DS Requestor Authentication Info
2 properties
authenticationResult
object
Cardholder Authentication Result from the Payment request.
3 properties
threeDSPurchaseInfo
object
Three DS Purchase Info
2 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…
primaryAddressIndicator
boolean
Indicates the 'TRUE'/'FALSE' value that represents whether or not an address is the primary address for a given owner
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.
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
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…
consumerPreferredPaymentNetwork
string
The consumer’s chosen card network to route eligible transactions when multiple networks are available. Valid Values are VI,MC, CB
addressIdentifier
string
Identifies a classification of a geographic area that is captured for a consumer purchasing goods or services.
createTimestamp
string
Designates the hour, minute and second in a specific day when the record was created.
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…
responseCode
string
Short explanation of the response code.
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.
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…
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.
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…
consumerProfileUniqueId
string
Identifies a unique occurrence of a consumer's information maintained by the Firm acorss merchant.
defaultMOP
object
Default payment method
4 properties
responseStatus
string
Request result status.
consumerProfileAddress
object
Address Information used for consumer profile
12 properties
merchantSoftware
object
Contains information related to the merchant software
3 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…
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…
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…
responseMessage
string
Long explanation of the response message.
threeDSAuthenticatedData
object
Three DS Authenticated Data
4 properties
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…
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…
authenticationRequest
object
Authentication Request
3 properties
communicationUpdate
object
Communication Update information
2 properties
updateTimestamp
string
Designates the hour, minute, and second in a specifc day when the record was last modified.
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…
paymentMethodType
object
Payment Method Object
5 properties
card
object
Card payment Information
23 properties
1 required
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…
accountNumberType
string
Specifies the type of payment method used by the account number in payment transaction.
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
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…
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…
fullName
string
Name of accoundholder business name.
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.).
email
object
Email information
3 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
