3D-Secure

Enroll 3DS

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

Endpoint

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.

Request Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholder-id	string	Yes	Cardholder Identification
x-wallet-id	string	Yes	Wallet Identification
x-card-id	string	Yes	Card Identification
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

Request Body Parameters

Parameter	Type	Required	Description
otp_delivery_method	string	Yes	OTP Delivery Method (eg:- "EMAIL", "SMS")

Request Example

cURL

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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--data '{
  "otp_delivery_method": "EMAIL"
}'

Response Example

200: Success

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

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

Update Enroll 3DS

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

Endpoint

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.

Request Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholder-id	string	Yes	Cardholder Identification
x-wallet-id	string	Yes	Wallet Identification
x-card-id	string	Yes	Card Identification
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

Request Body Parameters

Parameter	Type	Required	Description
otp_delivery_method	string	Yes	OTP Delivery Method (eg:- "EMAIL", "SMS")

Request Example

cURL

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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--data '{
  "otp_delivery_method": "SMS"
}'

Response Example

200: Success

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

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

Get Enroll 3DS Details

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

Endpoint

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.

Request Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholder-id	string	Yes	Cardholder Identification
x-wallet-id	string	Yes	Wallet Identification
x-card-id	string	Yes	Card Identification
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

Request Example

cURL

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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \

Response Example

200: Success

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

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

Unenroll 3DS Program

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

Endpoint

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.

Request Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholder-id	string	Yes	Cardholder Identification
x-wallet-id	string	Yes	Wallet Identification
x-card-id	string	Yes	Card Identification
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

Request Example

cURL

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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \

Response Example

200: Success

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

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}