Enroll a card in 3D Secure

Last updated: April 24, 2024

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 physical cards and multi-use virtual cards 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

Information

Online transactions performed using physical cards or multi-use virtual cards that have not been enrolled in 3DS are likely to be declined.

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 cards in 3DS using the Dashboard and the API.

Sign in to the Dashboard.
Go to Issuing > Cards.
Select the card you want to enroll. You can use search or filters to help find the card.
Select Set up 3D Secure. This option is not displayed if the card is already enrolled.
Fill in the required details.
Select Confirm.

Call the Enroll a card 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  "_links": {
3    "self": {
4      "href": "https://api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/3ds-enrollment",
5      "actions": [
6        "GET"
7      ],
8      "types": [
9        "application/json"
10      ]
11    }
12  }
13}

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

Information

You can use the Out-of-Band Authentication SDK for Android or iOS to perform 3DS authentication on cardholders from your app.

If your customer requests a change to their details, for example if they change their password or phone number, update the details of their enrolled card accordingly. You can do this using the Dashboard and the API.

Sign in to the Dashboard.
Go to Issuing > Cards.
Select the card you want to update the details for. You can use search or filters to help find the card.
Select Edit. This option is only displayed if the card is already enrolled.
Update the required details.
Select Save.

Call the Update a card's 3DS details endpoint.

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  "_links": {
3    "self": {
4      "href": "https://api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/3ds-enrollment",
5      "actions": [
6        "GET"
7      ],
8      "types": [
9        "application/json"
10      ]
11    }
12  }
13}

Enroll a card in 3D Secure

Information

Enroll a card

Enrol a card in the Dashboard

Enrol a card using the API

Request example

Response example

Information

Update enrollment details

Update enrollment details in the Dashboard

Update enrollment details using the API

Request example

Response example