Skip to main content

3D-Secure

Enroll 3DS Program​

This API allows you to create a new 3D Secure enrollment for a cardholder in the system.

POST {{baseUrl}}/issuing/api/:version/card/3DS

Description

Creates a new 3D Secure enrollment for a cardholder within the issuing platform. This API captures the cardholder’s authentication preferences and links the card to the 3D Secure system, ensuring that future online transactions are verified for enhanced security.

πŸ”— Path Parameters

version string required

API version number. Default value is v1.

πŸ“© Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

πŸ“¦ Body Parameters

otp_delivery_method string required

OTP Delivery Method. Allowed values: EMAIL, SMS.

Request Example

curl --location --request POST \
--url '{{baseUrl}}/issuing/api/:version/card/3DS' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
"otp_delivery_method": "EMAIL"
}'

Response Example

{
"status": "Success",
"message": "3DS enrollment successful.",
"code": 200,
"data": []
}

Get 3DS Details​

This API is used to retrieve the 3D Secure enrollment details for a cardholder in the system.

GET {{baseUrl}}/issuing/api/:version/card/3DS

Description

Retrieves the 3D Secure enrollment details for a specific cardholder in the system. This API provides information about the cardholder’s current 3D Secure status, authentication preferences, and enrollment settings. It helps verify whether a card is enrolled for 3D Secure and ensures that the correct authentication parameters are in place for secure online transactions.

πŸ”— Path Parameters

version string required

API version number. Default value is v1.

πŸ“© Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

Request Example

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/card/3DS' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Response Example

{
"status": "Success",
"message": "Enroll 3DS details fetched successfully.",
"code": 200,
"data": [
{
"otp_delivery_method": "SMS",
"destination": "+628000110022",
"status": "ACTIVE"
}
]
}

Update 3DS Details​

This API is used to update the 3D Secure enrollment for a cardholder in the system.

PATCH {{baseUrl}}/issuing/api/:version/card/3DS

Description

Updates the 3D Secure enrollment details for an existing cardholder within the issuing platform. This API allows modification of authentication preferences, such as OTP delivery method, ensuring that the cardholder’s 3D Secure profile remains accurate and up to date.

πŸ”— Path Parameters

version string required

API version number. Default value is v1.

πŸ“© Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

πŸ“¦ Body Parameters

otp_delivery_method string required

Updated OTP delivery method to be used for enrollment verification. Allowed values: EMAIL, SMS.

Request Example

curl --location --request PATCH \
--url '{{baseUrl}}/issuing/api/:version/card/3DS' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
"otp_delivery_method": "SMS"
}'

Response Example

{
"status": "Success",
"message": "3DS enrollment details updated successfully.",
"code": 200,
"data": []
}

Unenroll 3DS Program​

This API is used to unenroll the 3D Secure enrollment for a cardholder in the system.

DELETE {{baseUrl}}/issuing/api/:version/card/3DS

Description

Removes a cardholder’s enrollment from the 3D Secure program within the system. This API deactivates the card’s 3D Secure authentication settings, preventing the card from undergoing 3D Secure verification for future online transactions.

πŸ”— Path Parameters

version string required

API version number. Default value is v1.

πŸ“© Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

Request Example

curl --location --request DELETE \
--url '{{baseUrl}}/issuing/api/:version/card/3DS' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Response Example

{
"status": "Success",
"message": "3DS unenrollment completed successfully.",
"code": 200,
"data": []
}