Cardholder

Create Cardholder

This API allows you to create a new cardholder profile in the system.

Endpoint

POST {{baseUrl}}/issuing/api/:version/cardholder

Description

Creates a new cardholder record within the issuing platform. This API captures the personal details, contact information, and billing/delivery addresses of the customer. The created cardholder profile is then linked to future card issuance requests, ensuring proper identity, delivery, and billing setup.

🔗 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-agent-code string required

Shared Agent Code

x-subagent-code string required

Shared Sub-Agent Code

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

title string required

Cardholder title. Allowed values: Mr, Mrs, Miss.

firstName string required

First name of the cardholder. Max length: 14 characters.

middleName string

Middle name of the cardholder. Max length: 35 characters.

lastName string required

Last name of the cardholder. Max Length: 11 characters.

preferredName string required

Display or preferred name on the card. Max Length: 26 characters.

gender string required

Gender of the cardholder. Allowed values: M (Male), F (Female), O (Other).

dateOfBirth string required

Date of birth (ISO 8601 date format: YYYY-MM-DD).

mobileCountryNamestring

Mobile country (2-letter ISO 3166-2 code).

mobileCountryCode string required

Mobile country code without + sign. Only numeric digits (0–9) are allowed.

mobile string required

Mobile number without country code. Min length: 8 digits, Max length: 12 digits. Only numeric digits (0–9) are allowed.

nationality string required

Nationality (2-letter ISO 3166-2 code).

email string required

Email address of the cardholder.

deliveryAddress1 string

Primary delivery address line.
Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

deliveryAddress2 string

Secondary delivery address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

deliveryAddress3 string

Additional delivery address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

deliveryAddress4 string

Additional delivery address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

deliveryCity string

Delivery city.

deliveryState string

Delivery state or province. Max length: 20 characters.

deliveryCountry string

Delivery country (2-letter ISO 3166-2 code).

deliveryZipCode string

Delivery postal or zip code.

billingAddress1 string required

Primary billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

billingAddress2 string required

Secondary billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

billingAddress3 string

Additional billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

billingAddress4 string

Additional billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . - ( ).

billingCity string required

Billing city.

billingState string required

Billing state or province. Max length: 20 characters.

billingCountry string required

Billing country (2-letter ISO 3166-2 code).

billingZipCode string required

Billing postal or zip code.

kycProviderNamestringconditional

Name of the external KYC provider used for verification. Accepted values: SUMSUB, MYINFO, JUMIO, DIDIT.

Note:
1. Required only if the client uses their own KYC provider.
2. If the platform's default KYC provider is used, this field is not required.
3. The user's KYC verification must be completed before submitting this value.

kycReferenceIdstringconditional

Unique reference ID returned by the external KYC provider for the completed verification.

Note:
1. Required only when kycProviderName is provided.
2. This value should correspond to the verification reference generated by the selected KYC provider.
3. The user's KYC verification must be completed before submitting this value.

🧩 Examples
🧪 Try It Out

Request Example

cURL
Python
Java
NodeJs

curl --location --request POST \
--url '{{baseUrl}}/issuing/api/:version/cardholder' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-agent-code: {{Shared Agent Code}}' \
--header 'x-subagent-code: {{Shared Sub-Agent Code}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data-raw '{
  "title": "Mr",
  "firstName": "Sandeep",
  "middleName": "",
  "lastName": "Sharma",
  "preferredName": "S Sharma",
  "gender": "M",
  "dateOfBirth": "1998-08-11",
  "mobileCountryCode": "62",
  "mobile": "8234567896",
  "nationality": "IN",
  "email": "sandeep.test@yopmail.com",
  "deliveryAddress1": "10 Anson Road",
  "deliveryAddress2": "International Plaza",
  "deliveryCity": "Singapore",
  "deliveryState": "Central Region",
  "deliveryCountry": "SG",
  "deliveryZipCode": "079903",
  "billingAddress1": "1 Raffles Place",
  "billingAddress2": "Tower 2",
  "billingCity": "Singapore",
  "billingState": "Central Region",
  "billingCountry": "SG",
  "billingZipCode": "048616"
}'

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/cardholder"

payload = json.dumps({
  "title": "Mr",
  "firstName": "Sandeep",
  "middleName": "",
  "lastName": "Sharma",
  "preferredName": "S Sharma",
  "gender": "M",
  "dateOfBirth": "1998-08-11",
  "mobileCountryCode": "62",
  "mobile": "8234567896",
  "nationality": "IN",
  "email": "sandeep.test@yopmail.com",
  "deliveryAddress1": "10 Anson Road",
  "deliveryAddress2": "International Plaza",
  "deliveryCity": "Singapore",
  "deliveryState": "Central Region",
  "deliveryCountry": "SG",
  "deliveryZipCode": "079903",
  "billingAddress1": "1 Raffles Place",
  "billingAddress2": "Tower 2",
  "billingCity": "Singapore",
  "billingState": "Central Region",
  "billingCountry": "SG",
  "billingZipCode": "048616"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-agent-code': '{{Shared Agent Code}}',
  'x-subagent-code': '{{Shared Sub-Agent Code}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n  \"title\": \"Mr\",\r\n  \"firstName\": \"Sandeep\",\r\n  \"middleName\": \"\",\r\n  \"lastName\": \"Sharma\",\r\n  \"preferredName\": \"S Sharma\",\r\n  \"gender\": \"M\",\r\n  \"dateOfBirth\": \"1998-08-11\",\r\n  \"mobileCountryCode\": \"62\",\r\n  \"mobile\": \"8234567896\",\r\n  \"nationality\": \"IN\",\r\n  \"email\": \"sandeep.test@yopmail.com\",\r\n  \"deliveryAddress1\": \"10 Anson Road\",\r\n  \"deliveryAddress2\": \"International Plaza\",\r\n  \"deliveryCity\": \"Singapore\",\r\n  \"deliveryState\": \"Central Region\",\r\n  \"deliveryCountry\": \"SG\",\r\n  \"deliveryZipCode\": \"079903\",\r\n  \"billingAddress1\": \"1 Raffles Place\",\r\n  \"billingAddress2\": \"Tower 2\",\r\n  \"billingCity\": \"Singapore\",\r\n  \"billingState\": \"Central Region\",\r\n  \"billingCountry\": \"SG\",\r\n  \"billingZipCode\": \"048616\"\r\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/cardholder")
  .method("POST", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-agent-code", "{{Shared Agent Code}}")
  .addHeader("x-subagent-code", "{{Shared Sub-Agent Code}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

const axios = require('axios');
let data = JSON.stringify({
  "title": "Mr",
  "firstName": "Sandeep",
  "middleName": "",
  "lastName": "Sharma",
  "preferredName": "S Sharma",
  "gender": "M",
  "dateOfBirth": "1998-08-11",
  "mobileCountryCode": "62",
  "mobile": "8234567896",
  "nationality": "IN",
  "email": "sandeep.test@yopmail.com",
  "deliveryAddress1": "10 Anson Road",
  "deliveryAddress2": "International Plaza",
  "deliveryCity": "Singapore",
  "deliveryState": "Central Region",
  "deliveryCountry": "SG",
  "deliveryZipCode": "079903",
  "billingAddress1": "1 Raffles Place",
  "billingAddress2": "Tower 2",
  "billingCity": "Singapore",
  "billingState": "Central Region",
  "billingCountry": "SG",
  "billingZipCode": "048616"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/cardholder',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-agent-code': '{{Shared Agent Code}}', 
    'x-subagent-code': '{{Shared Sub-Agent Code}}', 
    'x-client-id': '{{ClientID}}',
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{AccessToken}}'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success
400: Error

{
  "status": "success",
  "message": "Cardholder created successfully.",
  "code": 200,
  "data": [
    {
      "id": "cardholder-id"
    }
  ]
}

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

Get Cardholder Details

This API is used to retrieve the cardholder details.

Endpoint

GET {{baseUrl}}/issuing/api/:version/cardholder

Description

Retrieves detailed information of a cardholder using the unique cardholderHash-id. This API provides cardholder profile data such as personal details, contact info, and address information.

🔗 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-cardholderHash-id string required

Unique identifier of the cardholder

x-client-id string

Client identification

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples
🧪 Try It Out

Request Example

cURL
Python
Java
NodeJs

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

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/cardholder"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholderHash-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/cardholder")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholderHash-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();     

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/cardholder',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholderHash-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});      

Response Example

200: Success
400: Error

{
  "status": "success",
  "message": "Cardholder details retrieved successfully",
  "code": 200,
  "data": [
    {
      "lastName": "Sharma",
      "gender": "M",
      "title": "Mr",
      "createAt": "2025-09-22 11:25:47",
      "billingAddress2": "Chowk Homes",
      "billingAddress1": "Park Street",
      "deliveryZipCode": "12SDF5",
      "billingCountry": "SG",
      "id": "cardholder-id",
      "preferredName": "S Sharma",
      "email": "sandeep.test@yopmail.com",
      "deliveryCity": "Kolkata",
      "mobileCountryCode": "65",
      "mobile": "123123123",
      "deliveryAddress2": "Action Area",
      "billingZipCode": "144003",
      "dateOfBirth": "1998-08-11",
      "billingState": "Punjab",
      "deliveryAddress1": "Mani Casadona",
      "firstName": "S",
      "nationality": "IN",
      "deliveryState": "West Bengal",
      "deliveryCountry": "SG",
      "middleName": "",
      "billingCity": "Malda",
      "status": "ACTIVE"
    }
  ]
}

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

Update Cardholder

This API allows you to update a cardholder profile in the system.

Endpoint

PATCH {{baseUrl}}/issuing/api/:version/cardholder

Description

Updates an existing cardholder record within the issuing platform. This API allows modification of the cardholder’s personal details, contact information, and billing/delivery addresses. The updated cardholder profile remains linked to associated cards and future card-related operations, ensuring accurate identity, delivery, and billing information.

🔗 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-cardholderHash-id string required

Unique identifier of the cardholder

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

title string

Cardholder title. Allowed values: Mr, Mrs, Miss.

firstName string

First name of the cardholder. Max length: 14 characters.

middleName string

Middle name of the cardholder. Max length: 35 characters.

lastName string

Last name of the cardholder. Max Length: 11 characters.

preferredName string

Display or preferred name on the card. Max Length: 26 characters.

gender string

Gender of the cardholder. Allowed values: M (Male), F (Female), O (Other).

dateOfBirth string

Date of birth (ISO 8601 date format: YYYY-MM-DD).

mobileCountryNamestring

Mobile country (2-letter ISO 3166-2 code).

mobileCountryCode string

Mobile country code without + sign. Only numeric digits (0–9) are allowed.

mobile string

Mobile number without country code. Min length: 8 digits, Max length: 12 digits. Only numeric digits (0–9) are allowed.

nationality string

Nationality (2-letter ISO 3166-2 code).

email string

Email address of the cardholder.

deliveryAddress1 string

Primary delivery address line.
Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

deliveryAddress2 string

Secondary delivery address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

deliveryAddress3 string

Additional delivery address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

deliveryAddress4 string

Additional delivery address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

deliveryCity string

Delivery city.

deliveryState string

Delivery state or province. Max length: 20 characters.

deliveryCountry string

Delivery country (2-letter ISO 3166-2 code).

deliveryZipCode string

Delivery postal or zip code.

billingAddress1 string

Primary billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

billingAddress2 string

Secondary billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

billingAddress3 string

Additional billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

billingAddress4 string

Additional billing address line. Max length: 35 characters.
Allows only letters, numbers, spaces (not at the start or end), and the characters _ @ # / , . -.

billingCity string

Billing city.

billingState string

Billing state or province. Max length: 20 characters.

billingCountry string

Billing country (2-letter ISO 3166-2 code).

billingZipCode string

Billing postal or zip code.

🧩 Examples
🧪 Try It Out

Request Example

cURL
Python
Java
NodeJs

curl --location --request PATCH \
--url '{{baseUrl}}/issuing/api/:version/cardholder' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholderHash-id: {{CardholderID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
  "firstName": "Sandeep",
  "lastName": "Sharma",
  "mobile": "8234567891"
}'

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/cardholder "

payload = json.dumps({
  "firstName": "Sandeep",
  "lastName": "Sharma",
  "mobile": "8234567891"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholderHash-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"firstName\": \"Sandeep\",\n  \"lastName\": \"Sharma\",\n  \"mobile\": \"8234567891\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/cardholder ")
  .method("PATCH", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholderHash-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

const axios = require('axios');
let data = JSON.stringify({
  "firstName": "Sandeep",
  "lastName": "Sharma",
  "mobile": "8234567891"
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/cardholder ',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholderHash-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success
400: Error

{
  "status": "success",
  "message": "CardHolder details updated successfully!",
  "code": 200,
  "data": [
    "CardHolder details updated successfully!"
  ]
}

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

Activate Cardholder

This API is used to reactivate / enable a previously deactivated cardholder profile in the system.

Endpoint

POST {{baseUrl}}/issuing/api/:version/cardholder/activate

Description

This API allows you to activate a registered cardholder whose profile was previously temporarily or permanently deactivated. Once activated, the cardholder regains full access to wallet and card functionalities.

🔗 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-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

🧩 Examples
🧪 Try It Out

Request Example

cURL
Python
Java
NodeJs

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

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/cardholder/activate"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/cardholder/activate")
  .method("POST", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/cardholder/activate',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success
400: Error

{
  "status": "success",
  "message": "CardHolder activated successfully!",
  "code": 200,
  "data": [
    "ACTIVE"
  ]
}

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

Deactivate Cardholder

This API is used to deactivates a cardholder profile from the system.

Endpoint

DELETE {{baseUrl}}/issuing/api/:version/cardholder

Description

This API allows you to deactivate a registered cardholder. The deactivation can be temporary or permanent depending on the value passed in the status field.

🔗 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-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

status string required

Cardholder status. Allowed values: Temporary Deactivate or Permanent Deactivate.

reason string required

Reason for deactivation.

🧩 Examples
🧪 Try It Out

Request Example

cURL
Python
Java
NodeJs

curl --location --request DELETE \
--url '{{baseUrl}}/issuing/api/:version/cardholder' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
  "status": "Temporary Deactivate",
  "reason": ""
}'

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/cardholder"

payload = json.dumps({
  "status": "Temporary Deactivate",
  "reason": ""
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"status\": \"Temporary Deactivate\",\n  \"reason\": \"\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/cardholder")
  .method("DELETE", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

const axios = require('axios');
let data = JSON.stringify({
  "status": "Temporary Deactivate",
  "reason": ""
});

let config = {
  method: 'delete',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/cardholder',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success
400: Error

{
  "status": "success",
  "message": "CardHolder deactivated successfully!",
  "code": 200,
  "data": [
    "Temporary Deactivate"
  ]
}

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

Create Cardholder​

Description

🔗 Path Parameters

📩 Request Headers

📦 Body Parameters

Request Example

Response Example

👤 Create Cardholder — Sandbox

🔐 Headers

📝 Request Body

💻 Generated cURL Command

Get Cardholder Details​

Description

🔗 Path Parameters

📩 Request Headers

Request Example

Response Example

ℹ️ Get Cardholder Details — Sandbox

🔐 Headers

💻 Generated cURL Command

Update Cardholder​

Description

🔗 Path Parameters

📩 Request Headers

📦 Body Parameters

Request Example

Response Example

🛠️ Update Cardholder — Sandbox

🔐 Headers

📝 Request Body

💻 Generated cURL Command

Activate Cardholder​

Description

🔗 Path Parameters

📩 Request Headers

Request Example

Response Example

⚡ Activate Cardholder — Sandbox

🔐 Headers

💻 Generated cURL Command

Deactivate Cardholder​

Description

🔗 Path Parameters

📩 Request Headers

📦 Body Parameters

Request Example

Response Example

⛔ Deactivate Cardholder — Sandbox

🔐 Headers

📝 Request Body

💻 Generated cURL Command

Create Cardholder

Get Cardholder Details

Update Cardholder

Activate Cardholder

Deactivate Cardholder