Managing 3D Secure Credentials
This section provides details of how to:
Creating a 3D Secure Credential
This API can be used to create a 3DS Authentication credential for a card.
Step 1: Retrieve card details
Before creating the credential for a card, identify the corresponding Public Token for the card to be used.
A card's public token is returned in the response to creating a card within the publicToken object.
Step 2: Create a 3D Secure credential
After identifying the public token for the card, you can create a 3D Secure credential for the card by executing a POST request to the Create 3DS Credential endpoint with the corresponding credential Type.
API Explorer
See the Create 3DS Credentials endpoint.
Credential Types
You can add multiple credentials to each card that you enrol in the 3D Secure service.
Credential Type | Description |
|---|---|
OTPSMS | During a 3D Secure session, Cardinal generates a single-use One-Time Password (OTP). GPS sends the OTP in an SMS text message to the cardholder’s mobile phone number and the cardholder enters the OTP in the 3D Secure screen to authenticate |
OTPEMAIL | During a 3D Secure session, Cardinal generates a single-use One-Time Password (OTP). GPS sends the OTP in an email message to the cardholder’s email address and the cardholder enters the OTP in the 3D Secure screen to authenticate the e-commerce transaction. |
BIOMETRIC | During a 3D Secure session, Cardinal sends a biometric authentication request to GPS and we forward this to your systems. You need to verify the cardholder using your customer smart phone application, via biometric data, such as a fingerprint scan or face recognition, obtained from the cardholder’s mobile device. Your customer application manages the biometric verification and returns a response to GPS. |
OUTOFBANDOTHER | During a 3D Secure session, Cardinal sends an authentication request to GPS and we forward this to your systems. You need to verify the cardholder using your customer In-App smart phone application; for example, by asking them to enter a username. Your customer application manages the verification and returns a response to GPS. |
You can find an example of Create 3DS credentials below.
curl --request POST \
--url https://cardsapi-uat.globalprocessing.net/cards/544551/3dscredentials \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"type": "EmailOTP",
"id": 11551,
"value": "[email protected]"
}
'
Update a Credential
This API can be used to update a 3DS Authentication credential for a card.
Step 1: Retrieve card details
Before updating the credential for a card, identify the corresponding Public Token for the card to be used.
A card's public token is returned in the response to creating a card within the publicToken object.
Step 2: Update a 3D Secure credential
After identifying the public token for the card, you can update or delete the 3D Secure credential for the card by executing a POST request to the Update 3DS Credential endpoint with the corresponding credential Type.
API Explorer
See the Update 3DS Credentials endpoint.
You can find an example of Update 3DS credentials below.
curl --request PUT \
--url https://cardsapi-uat.globalprocessing.net/cards/445415/3dscredentials \
--header 'Accept: application/ json' \
--header 'Content-Type: application/json' \
--data '
{
"id": 4411,
"type": "EmailOTP",
"value": "[email protected]"
}
'
List 3DS Credentials
The List 3DS Credentials API allows you to retrieve the 3DS credentials associated with a card. You can retrieve the 3DS credentials by making a GET request to the endpoint. For example:
{{base-url}}/cards/{{publicToken}}/3dscredentials
A successful response will return a HTTP 200 response code and a payload that will return the details for the 3DS credentials for the card. For example:
[
{
"type": "OTPSMS",
"value": "8988",
"id": 481725
}
]
API Explore
See the List 3DS Credentials endpoint.
Updated about 2 months ago