3D Secure payments with a third-party provider
Last updated: April 29, 2022
To benefit from a streamlined integration process, we recommend using Checkout.com to authenticate 3D Secure payments. If you wish you to use a third-party provider, you will need to include additional fields in your request.
Use the details below to set up your request.
For the full specification, as well as complete request and response examples, see our API reference.
post
https://api.checkout.com/payments
Header | Value |
---|---|
required |
Use the valid secret key of your Checkout.com account. You can find this in the Hub. |
required |
|
Parameter | Description |
---|---|
required object | Information required for 3D Secure payments. |
optional string | Indicates your preference for whether or not a 3DS challenge should be performed. The customer’s bank has the final say on whether the customer is challenged. If For more information about exemptions, see our SCA compliance guide. |
required string | Base-64 cryptographic identifier used by card schemes to validate the token verification result. Required unless the For more information, see stored card details. |
required string | The Electronic Commerce Indicator security level associated with the token. Required unless the For more information, see stored card details. |
required boolean | Whether to process this payment as a 3D Secure. Set this to |
optional string | Requests an SCA exemption for the transaction. The customer’s bank has the final say on whether or not it applies. If the requested For more information about exemptions, see our SCA compliance guide. |
required string | Indicates the version of 3D Secure used for authentication. Defaults to |
required (for 3DS1 requests, and 3DS2 requests for Mastercard and Amex)optional (for 3DS2 Visa requests)string | The 3D Secure transaction identifier. In 3DS2 with Mastercard, the value is the directory server transaction ID. |
1{2"source": {3"type": "card",4"number": "5436031030606378",5"expiry_month": 12,6"expiry_year": 20257},8"amount": 257,9"currency": "USD",10"3ds": {11"enabled": true,12"eci": "06",13"cryptogram": "123feb70-d16b-4da6-b07f-98c0",14"xid": "79f6205c-ff5c-4a4c-8fca-90f67f3a6470",15"version": "2.0.1"16}17}
If the approved
field is true
, your authorization was successful. If unsuccessful, the card used for the payment may be invalid/expired or the account has an insufficient available balance.
If you received a 202
response, the payment requires a redirect.
Information
If the card scheme provided us with an eci
value, it will be included in the response. The value indicates the security level that the card scheme decided to authorize the payment with.