The identity and technical contract details declared by the specification.
phone
object
Phone number in ITU-T E.164 format. Country code and phone number (subscriber number) are mandatory values
2 properties
1 required
challengeAuthenticationType
string
Indicates the category of authentication request the Issuer will use to challenge the Cardholder in a three domain secure authentication process.
threeDSTransactionId
string
Identifies a unique occurrence of a transaction. In this context, this is Universally unique transaction identifier to identify a single transaction. If the va…
electronicCommerceIndicator
string
Describes the Electronic Commerce Indicator used in cardholder authentication on a network token
accountHolderReferenceId
string
Merchant defined identifier for a consumer
updateTimestamp
string
Designates the hour, minute, and second in a specific day when the record was last modified.
authenticationPaymentMethodType
object
Authentication Payment Method Type
2 properties
threeDomainSecureExemption
object
Three Domain Secure Closure
3 properties
paymentToken
object
Token Information for the payment transaction
5 properties
authenticationRequest
object
Authentication Request information
9 properties
2 required
threeDomainSecureChallenge
object
Three Domain Secure Challenge
7 properties
merchantCategoryCode
string
MCC or Merchant Category Code. Defaults to MCC configured at the merchant profile level. Some configurations allow multiple MCC's under a single Merchant ID. S…
responseMessage
string
Long explanation of response code
responseCode
string
Short explanation for response status
challengeAuthenticationMethod
string
Information about how the 3DS Requestor authenticated the cardholder for the challenge request.
authenticationResult
object
Accountholder Authentication
6 properties
consumerAccountPasswordChangeLength
string
Indicates the length of time since the consumer account password was last updated in days.
authenticationAccount
object
Authentication Account
6 properties
2 required
merchantPurchaseDescription
string
Description of goods or services sold according to merchant's internal systems.
entity
string
The moniker given to the module or program where the error generated.
threeDSDirectoryServerTransactionId
string
Universally unique transaction identifier assigned by the DirectoryServer to identify a single transaction.
tokenServiceResponseCode
string
Short explanation of response Code
acsTransactionId
string
This data element provides additional information to the ACS to determine the best approach for handling a request. The field is limited to 36 characters conta…
year
integer
The year of the expiration date
responseStatus
string
Indicates whether API request resulted in success, error, or denial.
threeDSPurchaseRisk
object
Contains Risk related information provided by the 3DS Requestor.
10 properties
threeDSChallengeMerchantNotificationUrl
string
A reference to a web resource on the internet specifying its location on a computer network and a mechanism for retrieving. In this context, this is the notifi…
currency
string
Describes the currency type of the transaction
issuerAssignedAuthenticationExemption
string
Identifies the coded values assigned by issuer based on information in the authentication request, so that transactions do not have to go through strong custom…
address
object
Address Object
7 properties
month
integer
The month of the expiration date
accountNumber
string
The card or token number.
amount
integer
Total monetary value of the payment including all taxes and fees. For zero exponent currency codes (i.e. Japanese Yen) a virtual decimal of 2 is not expected
authenticationStatusReasonText
string
Long explanation of the Authentication Status
threeDSPurchaseInfo
object
Three DS Purchase Info
6 properties
2 required
browserInfo
object
Browser Information of the consumer
11 properties
authenticationMethod
string
Information about how the 3DS Requestor previously authenticated the cardholder.
threeDSChallengeType
string
Indicates whether a challenge is requested for this transaction.
challengeWindowSize
string
Dimensions of the challenge window that has been displayed to the Cardholder. The ACS shall reply with content that is formatted to appropriately render in thi…
tokenNumber
string
The token number is a secure surrogate value generated for an account number in a payment transaction. The token is substituted for the card number or primary…
lastName
string
Last name or surname
authenticationResponse
object
Authentication Response Information
13 properties
threeDomainSecureCompletion
object
Three Domain Secure Closure
18 properties
authenticationConsumerProfile
object
Consumer Profile information used for authentication purpose.
2 properties
2 required
issuerAssignedAuthenticationExemptionEncoded
string
Identifies the encoded textual value assigned by issuer based on information in the authentication request, so that transactions do not have to go through stro…
threeDSMethodUrl
string
A reference to a web resource on the internet specifying its location on a computer network and a mechanism for retrieving.
channelType
string
Codifies the method in which the order was initiated. If not provided, defaults to browser value.
threeDSTransactionStatusReasonCode
string
Contains code indicating the reason for the transaction status in threeDSTransactionStatus.
threeDomainSecureCreation
object
Three Domain Secure Creation
5 properties
threeDSVersion
string
Codifies the version of the Three Domain Secure (3-D Secure or 3DS) software that is used by the merchant. 3DS is a protocol designed to be an additional multi…
code
string
Short informative code about error
requestId
string
Merchant identifier for the request. The value must be unique.
validationMessage
object
Object containing information about transaction validation
3 properties
maskedAccountNumber
string
Identifies a concealed number associated with the card number recognized by various payment systems. This is typically concealed by storing only the first 6 an…
authenticationSupportUrl
string
Fully qualified URL of 3DS Requestor website or customer care site. This field is optional and it is recommended to be configured in the configuration.
authenticationValue
string
3DS Base 64 cryptogram obtained prior to payment request.
purchasedItemCount
integer
The number of items in the sale for the payment processing request.
tokenProvider
string
The label given to a provider who creates the digital token for cards.
message
string
Long informative message about error
threeDSRequestorAuthenticationInfo
object
Information about how the 3DS Requestor authenticated the cardholder before or during the transaction.
6 properties
1 required
authenticationValueCalculationMethod
string
Identifies the calculation method used by the issuer to generate the electronic commerce cryptogram for cardholder authentication.
cardTypeName
string
Name of the payment network
cvv
string
Card verification value (CVV/CV2)
middleName
string
Given name between first name and last name/surname.
authenticationType
string
Indicates the type of cardholder Authentication request requested by the authentication requestor.
recurringAuthorizationExpirationDate
string
Date after which no further authorizations shall be performed. This field is limited to 8 characters, and the accepted format is YYYYMMDD.
messageType
string
Codifies type of message requested by authentication server for cardholder authentication request initiated by requestor.
issuerAssignedAuthenticationFraudScore
string
Assigned by the card issuer this specifies the likelihood that an authorization will be fraudulent. The scale ranges from 0 to 99. The higher the score, the mo…
information
object
A list of informational messages
2 properties
threeDSAccountType
string
Indicates the type of consumer account is requested for authentication.
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.
consumerProfileId
string
Identifies a unique occurrence of a consumer maintained in the firm as requested by merchant. Consumer profile contains information relevant to processing tran…
softMerchant
object
Soft merchant information is passed to the card association along with the transaction. This soft merchant information may also be used for cases where smaller…
13 properties
authenticationId
string
Unique identifier for the Authentication attempt.
authenticationByIdRequest
object
Request information for authentication by Id call
14 properties
3 required
threeDSAccountAdditionalInfo
object
This field contains additional information about the Cardholder’s account provided by the 3DS Requestor.
18 properties
consumerInstallmentAuthorizationCount
integer
Indicates the maximum number of authorisations permitted for instalment payments.
threeDSTransactionStatus
string
Indicates whether a transaction qualifies as an authenticated transaction.
encryptionIntegrityCheck
string
The alphanumeric string generated by voltage to verify the soundness of the encrypted key used by merchant and payment process. The merchant passed this in the…
email
string
Optional value for merchants to provide for a transaction
expiry
object
Expiration date
2 properties
2 required
paymentMethodId
string
Identifies a unique occurrence of the type of payment accepted by a level of the hierarchy of the merchant acquiring account.
authenticationCard
object
card information used for authentication purpose.
9 properties
1 required
threeDSMessageExtension
object
Contains Data necessary to support requirements not otherwise defined in the 3D Secure message are carried in a Message Extension. This field is limited to 81.…
4 properties
authenticationByIdResponse
object
Authentication By Id Response
12 properties
threeDSSchemeId
string
The identifier of the scheme for better resolving of the versioning data for the security protocol used on cardholder authentication using 3DS.
threeDSAuthenticationTimestamp
string
Designates the hour, minute and second of the cardholder authentication
tokenServiceResponseMessage
string
Long explanation of response Message received from token service
messages
object
A list of errors and warnings.
5 properties
2 required
threeDSRequestorPriorAuthenticationInfo
object
Contains information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs JPMorgan Chase publishes across the network.
