Enroll a card in 3D Secure
Beta

Last updated: March 22, 2023

3D Secure (3DS) provides an additional security layer to your cardholders when making online payments. Enabling 3DS on your cards reduces the chance of fraudulent transactions and chargeback requests.

You must enroll a card in 3DS if:

You've issued the card within the European Economic Area (EEA) or the UK
The card that you issued can be used for online payments within the EEA or the UK

To comply with the Payment Services Directive 2 (PSD2) regulation, we support two-factor authentication. During your onboarding with us, you'll need to choose between one of the following two-factor authentication flows:

One-time password (OTP) sent through SMS and a password chosen by the cardholder
OTP sent through SMS and a security question and answer chosen by the cardholder

You can enroll a card in 3DS with the following endpoint:

post

https://api.checkout.com/issuing/cards/{cardId}/3ds-enrollment

The request must contain the cardholder's locale and the phone number that the OTP will be sent to.

You must also provide the authentication data that the cardholder will need to submit when completing a 3DS challenge during an online payment. Depending on your chosen authentication flow, this will either be a password, or a security question and answer pair.


1{
2  "password": "Xtui43FvfiZ",
3  "locale": "en-US",
4  "phone_number": {
5    "country_code": "+1",
6    "number": "415 555 2671"
7  }
8}


1{
2  "security_pair": {
3    "question": "What is my favorite animal?",
4    "answer": "Dog"
5  },
6  "locale": "en-US",
7  "phone_number": {
8    "country_code": "+1",
9    "number": "415 555 2671"
10  }
11}

If you receive a 202 response, the card was successfully enrolled in 3DS.


1{
2  "created_date": "2019-09-10T10:11:12Z",
3  "_links": {
4    "self": {
5      "href": "https://api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/3ds-enrollment"
6    }
7  }
8}

After you've enrolled a card, you can retrieve its enrollment details using the API.

If your customer requests a change to their details, for example if they change their password or phone number, you should update the details of their enrolled card accordingly.

patch

https://api.checkout.com/issuing/cards/{cardId}/3ds-enrollment


1{
2  "password": "Xtui43FvfiZ",
3  "locale": "en-US",
4  "phone_number": {
5    "country_code": "+1",
6    "number": "415 555 2671"
7  }
8}


1{
2  "last_modified_date": "2019-09-11T10:11:12Z",
3  "_links": {
4    "self": {
5      "href": "https://api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/3ds-enrollment"
6    }
7  }
8}

We've made some changes to our API

Enroll a card in 3D Secure
Beta

Enroll a card

Request example

Response example

Update enrollment details

Request example

Response example