3D Secure (3DS) is an authentication protocol designed to enhance the security of online transactions by verifying the identity of cardholders before a payment is processed. This endpoint initiates the enrolment flow for 3DS authentication, beginning the authentication process for a payment transaction.
Usage Scenarios:
Adding an extra layer of security to card payments and reducing fraud risk.
Complying with Strong Customer Authentication (SCA) requirements for transactions in the European Economic Area (EEA).
Notes:
The authentication flow is dynamically determined by factors such as card brand, issuing bank, and risk assessment.
Your integration must handle all possible authentication scenarios returned by the API.
The Data Share Only option shares transaction information from merchants with issuers, allowing for informed authorization decisions without full authentication, thus providing a frictionless experience. For Visa and Mastercard, use “requestor_challenge_indicator=06”.
For detailed information about 3DS authentication, including how it works, available scenarios, and implementation guidance, see the 3DS Authentication documentation.
Body application/json
currencystring
mdstring
ID defined by the merchant to identify the enrolment response
term_urlstring
amountinteger<int32>
payment_methodobject
Show payment_method properties
number_tokenstringrequired
security_codestringrequired
expiration_monthstringrequired
expiration_yearstringrequired
descriptionstring
operationstring
extra_fieldsobject
Show extra_fields properties
billing_addressobject
Data structure containing shipping address details
Show billing_address properties
streetstringrequired
Name of a street or thoroughfare
numberstringrequired
Number that identifies the position of a building on a street
complementstring
Additional address information
districtstring
Name of a district, for example, a part of a town or region
citystring
Name of a built-up area with defined boundaries and a local government.
The value is based on the ISO 3166-2, according to the country defined within the address details.
statestring
Name of an organized political community or area forming a part of a federation.
The value is based on the ISO 3166-2, according to the country defined within the address details.
The value consists of a group of letters and/or numbers that is added to a postal address to assist in sorting the mail.
referencestring
Reference point details that can be used to help locate the address
data_onlyobject
Data structure used to request a data_share_only 3DS flow, without a challenge
Show data_only properties
requestor_challenge_indicatorstring
3DS requestor challenge preference (EMV 3DS threeDSRequestorChallengeInd). Set to “06” to request no challenge and share cardholder data only.
Response
OK
transaction_idstring
mdstring
ID defined by the merchant to identify the enrolment response
tx_idinteger<int32>
xidstring
Field available from version 2.0 onwards. MPI identifier for each authenticated transaction. The field content can be a HEXA or Base64 value, according to the MPI used.
