Skip to content

Card Tokenization

The Card Tokenization system provides efficient management of, and access to, tokenized card details linked to your customers.

  • Unique customerId: Each customer is assigned a unique customerId, which is generated based on the customer’s email and phone number.
  • Tokenization and secure storage: The customerId will only be included in the successful transaction initiation response when the secureCard option is set to true. This indicates that the customer’s card details have been securely tokenized and stored for future use.
  • Remaining tokenization limit: The response will also include the remaining tokenization limit for the customer. This value indicates how many more cards can be securely stored (tokenized) for that specific customer.

This approach keeps card data securely linked to the correct customer while managing the tokenization process effectively.

Retrieve the list of digital cards associated with the provided customerId.

Parameter Mandatory Description Type Example
customerId Yes Unique identifier for the customer. String "4bf4f6a2-ba0a-420f-89a9-e718007ab11a"
Example Request
curl --location --request GET '{{baseUrl}}/customer/{customerId}/digitalCards' \
--header 'Authorization: Basic <base64-encoded-clientId:clientSecret>' \
--header 'X-Signature: <generated_signature>' \
--header 'X-MERCHANT-BROWSER-FINGERPRINT: 8357426ac73fcd60b17355ab7de60421' \
--header 'X-MERCHANT-USER-AGENT: <user-agent>' \
--header 'X-MERCHANT-DOMAIN: https://www.xyz.com' \
--header 'X-MERCHANT-IP: 123.123.123.123'
Success Response
{
"resCode": 200,
"status": "success",
"data": {
"digitalCards": [
{
"digitalCardId": "685a421bca91e50caa13300c",
"network": "visa",
"cardType": "credit",
"status": "ACTIVE",
"panLastFour": "1111",
"createdAt": "2025-06-24T06:13:47.869Z",
"updatedAt": "2025-06-24T06:13:47.869Z"
}
],
"remainingLimit": 4
}
}
ResCode Status Description
401 failure Missing Authorization header
401 failure Invalid or inactive client credentials
500 failure An error occurred while fetching digital cards

Fetch Digital Card Details by Digital Card ID

Section titled “Fetch Digital Card Details by Digital Card ID”

Retrieve the details of a specific digital card associated with the provided customerId and digitalCardId.

Parameter Mandatory Description Type Example
customerId Yes Unique identifier for the customer. String "4bf4f6a2-ba0a-420f-89a9-e718007ab11a"
digitalCardId Yes Unique identifier for the digital card. String "685a421bca91e50caa13300c"
Example Request
curl --location --request GET '{{baseUrl}}/customer/{customerId}/digitalCards/{digitalCardId}' \
--header 'Authorization: Basic <base64-encoded-clientId:clientSecret>' \
--header 'X-Signature: <generated_signature>' \
--header 'X-MERCHANT-BROWSER-FINGERPRINT: 8357426ac73fcd60b17355ab7de60421' \
--header 'X-MERCHANT-USER-AGENT: <user-agent>' \
--header 'X-MERCHANT-DOMAIN: https://www.xyz.com' \
--header 'X-MERCHANT-IP: 123.123.123.123'
Success Response
{
"resCode": 200,
"status": "success",
"data": {
"digitalCard": {
"digitalCardId": "685a421bca91e50caa13300c",
"network": "visa",
"cardType": "credit",
"status": "ACTIVE",
"panLastFour": "1111",
"createdAt": "2025-06-24T06:13:47.869Z",
"updatedAt": "2025-06-24T06:13:47.869Z"
},
"remainingLimit": 4
}
}
ResCode Status Description
401 failure Missing Authorization header
401 failure Invalid or inactive client credentials
500 failure An error occurred while fetching digital card

Delete a specific digital card from a customer’s record using the provided customerId and digitalCardId.

Parameter Mandatory Description Type Example
customerId Yes Unique identifier for the customer. String "4bf4f6a2-ba0a-420f-89a9-e718007ab11a"
digitalCardId Yes Unique identifier for the digital card. String "685a421bca91e50caa13300c"
Example Request
curl --location --request DELETE '{{baseUrl}}/customer/{customerId}/digitalCards/{digitalCardId}' \
--header 'Authorization: Basic <base64-encoded-clientId:clientSecret>' \
--header 'X-Signature: <generated_signature>' \
--header 'X-MERCHANT-BROWSER-FINGERPRINT: 8357426ac73fcd60b17355ab7de60421' \
--header 'X-MERCHANT-USER-AGENT: <user-agent>' \
--header 'X-MERCHANT-DOMAIN: https://www.xyz.com' \
--header 'X-MERCHANT-IP: 123.123.123.123'
Success Response
{
"resCode": 200,
"status": "success",
"data": {
"customerId": "4bf4f6a2-ba0a-420f-89a9-e718007ab11a",
"digitalCardId": "685b168ebf56f28d31f64428"
}
}
ResCode Status Description
404 failure Card not found or already deleted
401 failure Missing Authorization header
401 failure Invalid or inactive client credentials
500 failure An error occurred while removing digital card