Cardholder

You can create cardholders, which are authorized representatives of your business that can be issued cards.

Create Cardholder

Endpoint

POST {{baseUrl}}/zoqq/api/v1/card/cardholder

Description

Cardholders are authorized representatives of your business. Depending on the program, one or both of the following cardholder types are permitted: INDIVIDUAL and DELEGATE.

INDIVIDUAL : A cardholder who is associated with a named individual that is a representative of your business. Can be associated with a personalized or non-personalized card.
DELEGATE : A cardholder assigned only to non-personalized cards. They act as authorized users on behalf of your business. Cards issued to delegate cardholders will be associated with the name of your business.

Creating a cardholder requires passing a name screening process, which involves submitting basic information about the cardholder.

📩 Request Headers

x-api-key string required

Shared X-API key by Zoqq

x-product-id string required

Shared Product ID by Zoqq

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

agent-code string

Shared Agent Code

subagent-code string

Shared Sub Agent Code

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

📦 Request Body Parameters

email string required

Email address of the cardholder

mobile_number string required

Cardholder's mobile number

country_code string

Individual's nationality. (2-letter ISO 3166-2 country code)

individual object conditional

Details about the cardholder. Only relevant for individual cardholder type.

date_of_birth string required

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

name object required

Full name of the Individual. Only characters in English are supported

title string

Optional title of cardholder

first_name string required

First name of cardholder

middle_name string

Middle name of cardholder

last_name string required

Last name of cardholder

address object required

Physical address of cardholder

city string required

City of address

country string required

Country code (2-letter ISO 3166-2) of address

line1 string required

Address line 1

state string required

Address state

postcode string required

Address postal code

employers array

Information of the individual's employers

business_identifiers array

Local business registration number i.e. an official signal of identification for the business

country_code string

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

number string

Local business registration number

type string

Type of business registration number

business_name string

Name of the employer

postal_address object conditional

Optional postal address of the cardholder. Only required if different to address and physical cards are to be issued.

city string required

City of address

country string required

Country code (2-letter ISO 3166-2) of address

line1 string required

Address line 1

state string required

Address state

postcode string required

Address postal code

type string required

Type of cardholder. Allowed value: INDIVIDUAL, DELEGATE

created_by string required

Creator identifier

🧩 Examples

Request Example

cURL

curl --location --request POST \
--url '{{baseUrl}}/zoqq/api/v1/card/cardholder' \
--header 'x-api-key: {{Shared X-API key By Zoqq}}' \
--header 'x-product-id: {{Shared ProductID By Zoqq}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'
--data-raw '{
  "email": "testapiair78@yopmail.com",
  "mobile_number": "86689006",
  "individual": {
    "date_of_birth": "1990-01-01",
    "name": {
      "title": "Mr",
      "first_name": "John",
      "middle_name":"P",
      "last_name": "Doe"
    },
    "address": {
      "city": "New York",
      "country": "SG",
      "line1": "123 5th Avenue",
      "state": "NY",
      "postcode": "10001"
    }
  },
  "postal_address": {
    "city": "New York",
    "country": "SG",
    "line1": "123 5th Avenue",
    "state": "NY",
    "postcode": "10001"
  },
  "type": "INDIVIDUAL",
  "created_by": "test"
}'

Python

import requests
import json

url = "{{baseUrl}}/zoqq/api/v1/card/cardholder"

payload = json.dumps({
  "email": "testapiair78@yopmail.com",
  "mobile_number": "86689006",
  "individual": {
    "date_of_birth": "1990-01-01",
    "name": {
      "title": "Mr",
      "first_name": "John",
      "middle_name": "P",
      "last_name": "Doe"
    },
    "address": {
      "city": "New York",
      "country": "SG",
      "line1": "123 5th Avenue",
      "state": "NY",
      "postcode": "10001"
    }
  },
  "postal_address": {
    "city": "New York",
    "country": "SG",
    "line1": "123 5th Avenue",
    "state": "NY",
    "postcode": "10001"
  },
  "type": "INDIVIDUAL",
  "created_by": "test"
})
headers = {
  'x-api-key': '{{Shared X-API key By Zoqq}}',
  'x-product-id': '{{Shared ProductID By Zoqq}}',
  'x-request-id': '{{IdempotencyKey}}',
  'x-user-id': '{{UserID}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n      \"email\": \"testapiair78@yopmail.com\",\r\n      \"mobile_number\": \"86689006\",\r\n      \"individual\": {\r\n        \"date_of_birth\": \"1990-01-01\",\r\n        \"name\": {\r\n          \"title\": \"Mr\",\r\n          \"first_name\": \"John\",\r\n          \"middle_name\":\"P\",\r\n          \"last_name\": \"Doe\"\r\n        },\r\n        \"address\": {\r\n          \"city\": \"New York\",\r\n          \"country\": \"SG\",\r\n          \"line1\": \"123 5th Avenue\",\r\n          \"state\": \"NY\",\r\n          \"postcode\": \"10001\"\r\n        }\r\n      },\r\n      \"postal_address\": {\r\n        \"city\": \"New York\",\r\n        \"country\": \"SG\",\r\n        \"line1\": \"123 5th Avenue\",\r\n        \"state\": \"NY\",\r\n        \"postcode\": \"10001\"\r\n      },\r\n      \"type\": \"INDIVIDUAL\",\r\n      \"created_by\": \"test\"\r\n    }");
Request request = new Request.Builder()
  .url("{{baseUrl}}/zoqq/api/v1/card/cardholder")
  .method("POST", body)
  .addHeader("x-api-key", "{{Shared X-API key By Zoqq}}")
  .addHeader("x-product-id", "{{Shared ProductID By Zoqq}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("x-user-id", "{{UserID}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');
let data = JSON.stringify({
  "email": "testapiair78@yopmail.com",
  "mobile_number": "86689006",
  "individual": {
    "date_of_birth": "1990-01-01",
    "name": {
      "title": "Mr",
      "first_name": "John",
      "middle_name": "P",
      "last_name": "Doe"
    },
    "address": {
      "city": "New York",
      "country": "SG",
      "line1": "123 5th Avenue",
      "state": "NY",
      "postcode": "10001"
    }
  },
  "postal_address": {
    "city": "New York",
    "country": "SG",
    "line1": "123 5th Avenue",
    "state": "NY",
    "postcode": "10001"
  },
  "type": "INDIVIDUAL",
  "created_by": "test"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card/cardholder',
  headers: { 
    'x-api-key': '{{Shared X-API key By Zoqq}}', 
    'x-product-id': '{{Shared ProductID By Zoqq}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    '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

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

400: Error

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

🧪 Try It Out

🪪 Create Cardholder — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

📝 Request Body

{ "email": "test@yopmail.com", "mobile_number": "86689006", "individual": { "date_of_birth": "1990-01-01", "name": { "title": "Mr", "first_name": "John", "middle_name": "P", "last_name": "Doe" }, "address": { "city": "New York", "country": "SG", "line1": "123 5th Avenue", "state": "NY", "postcode": "10001" } }, "postal_address": { "city": "New York", "country": "SG", "line1": "123 5th Avenue", "state": "NY", "postcode": "10001" }, "type": "INDIVIDUAL", "created_by": "test" }

💻 Generated cURL Command

❯

Get All Cardholders

Endpoint

GET {{baseUrl}}/zoqq/api/v1/card/cardholder

Description

This API returns a list of all cardholders, allowing you to view and manage cardholder details easily.

📩 Request Headers

x-api-key string required

Shared X-API key by Zoqq

x-product-id string required

Shared Product ID by Zoqq

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

🔍 Query Parameters

status string

Cardholder status filter. Allowed values: PENDING, READY

page_num integer

Page number for pagination

page_size integer

Number of items per page

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/zoqq/api/v1/card/cardholder' \
--header 'x-api-key: {{Shared X-API key By Zoqq}}' \
--header 'x-product-id: {{Shared ProductID By Zoqq}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'

Python

import requests
import json

url = "{{baseUrl}}/zoqq/api/v1/card/cardholder"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key By Zoqq}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'x-product-id': '{{Shared ProductID By Zoqq}}',
  'x-user-id': '{{UserID}}',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.json())

Java

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

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card/cardholder',
  headers: { 
    'x-api-key': '{{Shared X-API key By Zoqq}}', 
    'x-product-id': '{{Shared ProductID By Zoqq}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    '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

{
  "status": "success",
  "message": "Cardholder fetched successfully",
  "code": 200,
  "data": [
    {
      "id": "cardholder-id",
      "email": "demo@yopmail.com",
      "status": "READY",
      "individual": null,
      "mobile_number": "91-95053039",
      "postal_address": null,
      "type": "DELEGATE",
      "created_by": "test",
      "created_at": "2025-07-10T05:42:45"
    },
    {
      "id": "cardholder-id",
      "email": "testapiair99@yopmail.com",
      "status": "PENDING",
      "individual": {
        "date_of_birth": "1990-01-01",
        "identification": {
          "country": "US",
          "expiry_date": "2030-12-31",
          "number": "ID123456789",
          "type": "PASSPORT"
        },
        "name": {
          "title": "miss",
          "first_name": "John",
          "middle_name": "singh",
          "last_name": "Doe"
        },
        "address": {
          "city": "New York",
          "country": "SG",
          "line1": "123 5th Avenue",
          "state": "NY",
          "postcode": "10001"
        }
      },
      "mobile_number": "1234567890",
      "postal_address": {
        "city": "New York",
        "country": "SG",
        "line1": "123 5th Avenue",
        "state": "NY",
        "postcode": "10001"
      },
      "type": "INDIVIDUAL",
      "created_by": "test",
      "created_at": "2025-08-08T06:03:12"
    }
  ]
}

400: Error

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

🧪 Try It Out

🧾 Get All Cardholders — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters (Optional)

❯

💻 Generated cURL Command

❯

Get Cardholder Details

Endpoint

GET {{baseUrl}}/zoqq/api/v1/card/cardholder

Description

This API is used to retrieve the details of a specific cardholder. You must provide the Cardholder ID as a query parameter to identify the cardholder.

📩 Request Headers

x-api-key string required

Shared X-API key by Zoqq

x-product-id string required

Shared Product ID by Zoqq

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

🔍 Query Parameters

id string required

Unique identifier for cardholder

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}' \
--header 'x-api-key: {{Shared X-API key By Zoqq}}' \
--header 'x-product-id: {{Shared ProductID By Zoqq}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'

Python

import requests
import json

url = "{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key By Zoqq}}',
  'x-product-id': '{{Shared ProductID By Zoqq}}',
  'x-request-id': '{{IdempotencyKey}}',
  'x-user-id': '{{UserID}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

Java

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

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}',
  headers: { 
    'x-api-key': '{{Shared X-API key By Zoqq}}', 
    'x-product-id': '{{Shared ProductID By Zoqq}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    '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

{
  "status": "success",
  "message": "Cardholder fetched successfully",
  "code": 200,
  "data": [
    {
      "id": "cardholder-id",
      "email": "demo@yopmail.com",
      "status": "READY",
      "individual": null,
      "mobile_number": "91-95053039",
      "postal_address": null,
      "type": "DELEGATE",
      "created_by": "test",
      "created_at": "2025-07-10T05:42:45"
    }
  ]
}

400: Error

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

🧪 Try It Out

📇 Get Cardholder Details — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

id:

💻 Generated cURL Command

❯

Update Cardholder

Endpoint

PATCH {{baseUrl}}/zoqq/api/v1/card/cardholder

Description

This endpoint updates card holder information including physical address, postal address, and contact details.Update a cardholder with selected information. All fields are optional, and only those provided will be updated. If a composite object, e.g. name is provided, then all of its child fields must be provided and valid. Updating the cardholder may re-trigger the name screening process.

📩 Request Headers

x-api-key string required

Shared X-API key by Zoqq

x-product-id string required

Shared Product ID by Zoqq

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

📦 Request Body Parameters

mobile_number string

Cardholder's mobile number

country_code string

Individual's nationality. (2-letter ISO 3166-2 country code)

individual object conditional

Details about the cardholder. Only relevant for individual cardholder type.

address object required

Physical address of cardholder

city string required

City of address

country string required

Country code (2-letter ISO 3166-2 ) of address

line1 string required

Address line 1

state string required

Address state

postcode string required

Address postal code

postal_address object conditional

Optional postal address of the cardholder. Only required if different to address and physical cards are to be issued.

city string required

City of address

country string required

Country code (2-letter ISO 3166-2 ) of address

line1 string required

Address line 1

state string required

Address state

postcode string required

Address postal code

updated_by string required

User updating the details

🔍 Query Parameters

id string required

Unique identifier for cardholder

🧩 Examples

Request Example

cURL

curl --location --request PATCH \
--url '{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}' \
--header 'x-api-key: {{Shared X-API key By Zoqq}}' \
--header 'x-product-id: {{Shared ProductID By Zoqq}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'
--data '{
  "individual": {
    "address": {
      "city": "Austin",
      "country": "US",
      "line1": "1234 Elm Street",
      "state": "TX",
      "postcode": "94932"
    }
  },
  "postal_address": {
    "city": "Los Angeles",
    "country": "US",
    "line1": "5678 Oak Avenue",
    "state": "CA",
    "postcode": "94932"
  }, 
  "updated_by": "user"
}'

Python

import requests
import json

url = "{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}"

payload = json.dumps({
  "individual": {
    "address": {
      "city": "Austin",
      "country": "US",
      "line1": "1234 Elm Street",
      "state": "TX",
      "postcode": "94932"
    }
  },
  "postal_address": {
    "city": "Los Angeles",
    "country": "US",
    "line1": "5678 Oak Avenue",
    "state": "CA",
    "postcode": "94932"
  },
  "updated_by": "user"
})
headers = {
  'x-api-key': '{{Shared X-API key By Zoqq}}',
  'x-product-id': '{{Shared ProductID By Zoqq}}',
  'x-request-id': '{{IdempotencyKey}}',
  'x-user-id': '{{UserID}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n  \"individual\": {\r\n    \"address\": {\r\n      \"city\": \"Austin\",\r\n      \"country\": \"US\",\r\n      \"line1\": \"1234 Elm Street\",\r\n      \"state\": \"TX\",\r\n      \"postcode\": \"94932\"\r\n    }\r\n  },\r\n  \"postal_address\": {\r\n    \"city\": \"Los Angeles\",\r\n    \"country\": \"US\",\r\n    \"line1\": \"5678 Oak Avenue\",\r\n    \"state\": \"CA\",\r\n    \"postcode\": \"94932\"\r\n  },\r\n  \"updated_by\": \"user\"\r\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}")
  .method("PATCH", body)
  .addHeader("x-api-key", "{{Shared X-API key By Zoqq}}")
  .addHeader("x-product-id", "{{Shared ProductID By Zoqq}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("x-user-id", "{{UserID}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let data = JSON.stringify({
  "individual": {
    "address": {
      "city": "Austin",
      "country": "US",
      "line1": "1234 Elm Street",
      "state": "TX",
      "postcode": "94932"
    }
  },
  "postal_address": {
    "city": "Los Angeles",
    "country": "US",
    "line1": "5678 Oak Avenue",
    "state": "CA",
    "postcode": "94932"
  },
  "updated_by": "user"
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}',
  headers: { 
    'x-api-key': '{{Shared X-API key By Zoqq}}', 
    'x-product-id': '{{Shared ProductID By Zoqq}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    '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

{
  "status": "success",
  "message": "Cardholder updated successfully.",
  "code": 200
}

400: Error

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

🧪 Try It Out

🛠 Update Cardholder — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

id:

📝 Request Body

{ "individual": { "address": { "city": "Austin", "country": "US", "line1": "1234 Elm Street", "state": "TX", "postcode": "94932" } }, "postal_address": { "city": "Los Angeles", "country": "US", "line1": "5678 Oak Avenue", "state": "CA", "postcode": "94932" }, "updated_by": "user" }

💻 Generated cURL Command

❯

Delete Cardholder

Endpoint

DELETE {{baseUrl}}/zoqq/api/v1/card/cardholder

Description

Permanently deletes a specified cardholder from the system. This action is irreversible.

📩 Request Headers

x-api-key string required

Shared X-API key by Zoqq

x-product-id string required

Shared Product ID by Zoqq

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

🔍 Query Parameters

id string required

Unique Identifier for cardholder

🧩 Examples

Request Example

cURL

curl --location --request DELETE \
--url '{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}' \
--header 'x-api-key: {{Shared X-API key By Zoqq}}' \
--header 'x-product-id: {{Shared ProductID By Zoqq}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'

Python

import requests
import json

url = "{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key By Zoqq}}',
  'x-product-id': '{{Shared ProductID By Zoqq}}',
  'x-request-id': '{{IdempotencyKey}}',
  'x-user-id': '{{UserID}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}")
  .method("DELETE", body)
  .addHeader("x-api-key", "{{Shared X-API key By Zoqq}}")
  .addHeader("x-product-id", "{{Shared ProductID By Zoqq}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("x-user-id", "{{UserID}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'delete',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card/cardholder?id={{CardholderID}}',
  headers: { 
    'x-api-key': '{{Shared X-API key By Zoqq}}', 
    'x-product-id': '{{Shared ProductID By Zoqq}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    '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

{
  "status": "success",
  "message": "Cardholder deleted successfully.",
  "code": 200
}

400: Error

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

🧪 Try It Out

🗑️ Delete Cardholder — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

id:

💻 Generated cURL Command

❯