Cards

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. Two types of cardholders 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": "test123@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\": \"test123@yopmail.com\",\r\n\"mobile_number\": \"11111222222\",\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}\r\n\r\n\r\n\n\n\n\n\n\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

status:

page_num:

page_size:

💻 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

❯

Create Card

Endpoint

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

Description

The card object represents the resource associated with a card issued by Zoqq. It contains details such as the linked account, embossed name (for physical cards), shipping method and information (for physical cards), and card-based spend controls (e.g., transaction limits, blocked merchant category codes, etc.). The card object also specifies the intended user (e.g., clients, customers, or employees), the form factor (physical or virtual), and the usage type (single-use or multi-use).

📩 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

card_issuance_action string required

Card issuance type. Allowed values: NEW, REPLACEMENT

card_type string required

Type of card. Allowed values: PHYSICAL, VIRTUAL

card_holder_id string required

The ID of the cardholder to associate this card with.

created_by string required

Full legal name of user requesting new card

request_id string required

Unique request ID used for idempotency

program object required

Program details for card issuance.

purpose string required

Purpose of the card. Allowed values: COMMERCIAL, CONSUMER.

authorization_controls object required

Transaction control configurations.

allowed_transaction_count string required

Specifies whether this card is a Single or Multiple Use card. Possible values are SINGLE, MULTIPLE. Single Use means that the card can only be used for 1 successful debit transaction.

transaction_limits object required

Configuration for transaction limits.

currency string required

Currency for transaction limits (3-letter ISO-4217 code)

limits array required

Transaction limits are based on interval and amount

amount double required

Transaction limit amount. Must be greater than 0.

interval string required

Limit interval: PER_TRANSACTION, DAILY, WEEKLY, MONTHLY, ALL_TIME.

postal_address object conditional

Delivery detail of the card. Only available for physical cards

city string required

City name.

country string required

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

line1 string required

Street address line 1.

state string required

State or province.

postcode string required

Postal or ZIP code.

is_personalized boolean required

Indicates whether the card is assigned to a single individual or to the business with multiple authorized users. Only personalized cards can be physical and added to digital wallets.

🧩 Examples

Request Example

cURL

curl --location --request POST \
--url '{{baseUrl}}/zoqq/api/v1/card' \
--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 '{
  "card_issuance_action": "NEW",
  "card_type": "PHYSICAL",
  "card_holder_id": "{{CardholderID}}",
  "created_by": "Postman Test",
  "request_id": "{{IdempotencyKey}}",
  "program": {
    "purpose": "COMMERCIAL"
  },
  "authorization_controls": {
    "allowed_transaction_count": "MULTIPLE",
    "transaction_limits": {
      "currency": "SGD",
      "limits": [
        {
          "amount": 10000,
          "interval": "PER_TRANSACTION"
        }
      ]
    }
  },
  "postal_address": {
    "city": "Singapore",
    "country": "SG",
    "line1": "21 Pasir Ris Street 72",
    "state": "Singapore",
    "postcode": "518764"
  },
  "is_personalized": true
}'

Python

import requests
import json

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

payload = json.dumps({
  "card_issuance_action": "NEW",
  "card_type": "PHYSICAL",
  "card_holder_id": "{{CardholderID}}",
  "created_by": "Postman Test",
  "request_id": "{{IdempotencyKey}}",
  "program": {
    "purpose": "COMMERCIAL"
  },
  "authorization_controls": {
    "allowed_transaction_count": "MULTIPLE",
    "transaction_limits": {
      "currency": "SGD",
      "limits": [
        {
          "amount": 10000,
          "interval": "PER_TRANSACTION"
        }
      ]
    }
  },
  "postal_address": {
    "city": "Singapore",
    "country": "SG",
    "line1": "21 Pasir Ris Street 72",
    "state": "Singapore",
    "postcode": "518764"
  },
  "is_personalized": True
})
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("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      \"card_issuance_action\": \"NEW\",\r\n      \"card_type\": \"PHYSICAL\",\r\n      \"card_holder_id\": \"{{CardholderID}}\",\r\n      \"created_by\": \"Postman Test\",\r\n      \"request_id\": \"{{IdempotencyKey}}\", \n      \"program\": {\r\n        \"purpose\": \"COMMERCIAL\"},\r\n      \"authorization_controls\": {\r\n        \"allowed_transaction_count\": \"MULTIPLE\",\r\n        \"transaction_limits\": {\r\n          \"currency\": \"SGD\",\r\n          \"limits\": [\r\n            {\r\n              \"amount\": 10000,\r\n              \"interval\": \"PER_TRANSACTION\"\r\n            }\r\n          ]\r\n        }\r\n      },\r\n      \"postal_address\": {\r\n            \"city\": \"Singapore\",\r\n                \"country\": \"SG\",\r\n                \"line1\": \"21 Pasir Ris Street 72\",\r\n                \"state\": \"Singapore\",\r\n                \"postcode\": \"518764\"\r\n      },\r\n      \"is_personalized\": true\r\n    }");
Request request = new Request.Builder()
  .url("{{baseUrl}}/zoqq/api/v1/card")
  .method("POST", 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 data = JSON.stringify({
  "card_issuance_action": "NEW",
  "card_type": "PHYSICAL",
  "card_holder_id": "{{CardholderID}}",
  "created_by": "Postman Test",
  "request_id": "{{IdempotencyKey}}",
  "program": {
    "purpose": "COMMERCIAL",
    "type": "DEBIT"
  },
  "authorization_controls": {
    "allowed_transaction_count": "MULTIPLE",
    "transaction_limits": {
      "currency": "SGD",
      "limits": [
        {
          "amount": 10000,
          "interval": "PER_TRANSACTION"
        }
      ]
    }
  },
  "postal_address": {
    "city": "Singapore",
    "country": "SG",
    "line1": "21 Pasir Ris Street 72",
    "state": "Singapore",
    "postcode": "518764"
  },
  "is_personalized": true
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card',
  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

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "id": "card-id"
  }
}

400: Error

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

🧪 Try It Out

💳 Create Card — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

📝 Request Body

Individual - Physical▾

{ "card_issuance_action": "NEW", "card_type": "PHYSICAL", "card_holder_id": "individual_cardholder_id", "created_by": "Postman Test", "request_id": "your-request-id", "program": { "purpose": "COMMERCIAL" }, "authorization_controls": { "allowed_transaction_count": "MULTIPLE", "transaction_limits": { "currency": "SGD", "limits": [ { "amount": 10000, "interval": "PER_TRANSACTION" } ] } }, "postal_address": { "city": "Orchard Plaza", "country": "SG", "line1": "123 Orchard Road", "state": "Singapore", "postcode": "238885" }, "is_personalized": true }

💻 Generated cURL Command

❯

Get All Cards

Endpoint

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

Description

This endpoint returns a list of all cards (both physical and virtual) associated with the authenticated user. The response includes key card attributes such as card status, masked number, type, associated cardholder ID, and timestamps for creation and updates.
You can also filter the results using query parameters such as card ID and card status to retrieve specific card records.

📩 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

Unique identifier for card

status string

Card status filter. Allowed values: ACTIVE, INACTIVE

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' \
--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

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

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.get(url, headers=headers, params=params)
print(response.json())

Java

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create("{{baseUrl}}/zoqq/api/v1/card"))
  .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}}")
  .addHeader("Content-Type", "application/json")
  .header("Authorization", "Bearer {{AccessToken}}")
  .method("GET", HttpRequest.BodyPublishers.noBody())
  .build();
HttpResponse<String> response = HttpClient.newHttpClient()
  .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card',
  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

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "cardHashId": "card-hash-id",
      "cardStatus": "ACTIVE",
      "maskedCardNumber": "************4639",
      "cardholderId": "",
      "createdAt": "2025-04-02T07:36:56.973+0000",
      "updatedAt": "2025-04-23T05:45:12.422+0000",
      "nameOnCard": "Postman Test",
      "cardType": "VIRTUAL",
      "currency": "USD"
    },
    {
      "cardHashId": "card-hash-id",
      "cardStatus": "INACTIVE",
      "maskedCardNumber": "************6886",
      "cardholderId": "",
      "createdAt": "2025-03-31T08:02:20.000+0000",
      "updatedAt": "2025-03-31T08:02:20.000+0000",
      "nameOnCard": "demozoqq",
      "cardType": "PHY",
      "currency": "SGD"
    }
  ]
}

400: Error

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

🧪 Try It Out

📂 Get All Cards — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

id:

status:

page_num:

page_size:

💻 Generated cURL Command

❯

Get All Cards By Cardholder ID

Endpoint

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

Description

This API allows you to retrieve all cards associated with a particular cardholder from the system.

📩 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

cardholder_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": "Card fetched successfully",
  "code": 200,
  "data": [
    {
      "card_hash_id": "card-hash-id",
      "card_status": "ACTIVE",
      "masked_card_number": "************1163",
      "cardholder_id": "cardholder_id",
      "created_at": "2025-08-13T08:29:04",
      "updated_at": null,
      "name_on_card": "test",
      "card_type": "VIRTUAL",
      "currency": "USD",
      "postal_address": null
    },
    {
      "card_hash_id": "card-hash-id",
      "card_status": "ACTIVE",
      "masked_card_number": "************0647",
      "cardholder_id": "cardholder_id",
      "created_at": "2025-08-13T07:19:17",
      "updated_at": null,
      "name_on_card": "10210",
      "card_type": "VIRTUAL",
      "currency": "USD",
      "postal_address": null
    }
  ]
}

400: Error

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

🧪 Try It Out

📂 Get All Cards by Cardholder ID — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

cardholder_id:

💻 Generated cURL Command

❯

Show Card Details

Endpoint

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

Description

This endpoint returns sensitive card details that are typically masked in other endpoints.

📩 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 card

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/zoqq/api/v1/card/detail?id={{CardID}}' \
--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

url = "{{baseUrl}}/zoqq/api/v1/card/detail"
params = {
  "id": "{{CardID}}"
}

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.get(url, headers=headers, params=params)
print(response.json())

Java

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create("{{baseUrl}}/zoqq/api/v1/card/detail?id={{CardID}}"))
  .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}}")
  .method("GET", HttpRequest.BodyPublishers.noBody())
  .build();
HttpResponse<String> response = HttpClient.newHttpClient()
  .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card/detail?id={{CardID}}',
  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": "Card details fetched successfully.",
  "code": 200,
  "data": [
    {
      "personalized": true,
      "card_id": "card-id",
      "card_bin": null,
      "card_scheme": "VISA",
      "card_currency": "SGD",
      "card_number": "************2145",
      "form_factor": "PHYSICAL",
      "mode_type": null,
      "card_product_id": null,
      "card_limit": 15000.0,
      "available_balance": null,
      "cardholder": {
        "cardholder_id": "cardholder-id",
        "email": "",
        "number_of_cards": null,
        "first_name": "",
        "last_name": null,
        "create_time": "2025-08-27T12:04:10.912+0000",
        "cardholder_status": null,
        "date_of_birth": null,
        "country_code": "SG",
        "phone_number": ""
      },
      "spending_controls": [
        {
          "amount": 15000.0,
          "interval": "PER_TRANSACTION",
          "remaining": 15000.0
        }
      ],
      "authorization_controls": {
        "active_from": "2025-08-27T00:00:00.000+00:00",
        "active_to": "2025-12-31T23:59:59.000+00:00",
        "allowed_currencies": [
          "USD",
          "EUR",
          "INR"
        ],
        "allowed_merchant_categories": []
      },
      "no_pin_payment_amount": null,
      "risk_controls": null,
      "metadata": {},
      "card_status": "INACTIVE",
      "brand": "VISA",
      "cardholder_id": "cardholder-id",
      "created_at": null,
      "created_by": "user",
      "is_personalized": true,
      "name_on_card": "John Doe",
      "nick_name": "Testair",
      "program": {
        "purpose": "COMMERCIAL",
        "type": "DEBIT"
      },
      "purpose": null,
      "delivery_details": {
        "delivery_mode": "MAIL",
        "delivery_vendor": "DHL",
        "status": "PRINTED",
        "tracked": true,
        "tracking_link": "tracking-link",
        "tracking_number": "ABCD1234",
        "updated_at": "2026-02-06T00:00:00.000+0000"
      },
      "postal_address": {
        "city": "Singapore",
        "country": "SG",
        "line1": "21 Pasir Ris Street 72",
        "line2": "null",
        "postcode": "518764",
        "state": "Singapore"
      }
    }
  ]
}

400: Error

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

🧪 Try It Out

💳 Get Card Details — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameter

id:

💻 Generated cURL Command

❯

Activate Card

Endpoint

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

Description

This API is used to activate a physical card for card payment authorizations.

📩 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 card to activate

🧩 Examples

Request Example

cURL

curl --location --request POST \
--url '{{baseUrl}}/zoqq/api/v1/card/activate?id={{CardID}}' \
--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/activate?id={{CardID}}"

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("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, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/zoqq/api/v1/card/activate?id={{CardID}}")
  .method("POST", 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: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card/activate?id={{CardID}}',
  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

{
  "code": 200,
  "status": "success",
  "message": "card activated successfully"
}

400: Error

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

🧪 Try It Out

💳 Activate Card — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

id:

💻 Generated cURL Command

❯

Update Card

This API updates card details including authorization controls and status.

Endpoint

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

Description

This endpoint updates card details by setting the values of the included parameters. Parameters that are not included will be left unchanged.

📩 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

card_status string

Card status. Allowed values: ACTIVE, INACTIVE, CLOSED.

currency string

Currency for transaction limits (3-letter ISO-4217 code).

transaction_limits array

Array of transaction limits.

type string required

Type of limit. Allowed values: PER_TRANSACTION, DAILY, WEEKLY, MONTHLY, ALL_TIME.

value double required

Numerical value of the transaction limit.

authorization_controls object

Controls for restricting card authorization.

active_from string

Start date-time from which card is active (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ).

active_to string

End date-time until which card remains active. (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ).

allowed_currencies array of string

Allowed currencies for card transactions following 3-letter ISO-4217 currency code.
(e.g.: ["USD", "EUR"]).

allowed_merchant_categories array of string

Allowed merchant category codes (4-digit MCCs).

updated_by string required

User updating the details

🔍 Query Parameters

id string required

Unique identifier for card to update

🧩 Examples

Request Example

cURL

curl --location --request PATCH \
--url '{{baseUrl}}/zoqq/api/v1/card?id={{CardID}}' \
--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 '{
  "card_status": "ACTIVE",
  "currency": "USD",        
  "transaction_limits": [
    {
      "type": "DAILY",
      "value": 1
    }
  ],
  "authorization_controls": {
    "active_from": "2025-05-01T00:00:00Z",
    "active_to": "2025-12-31T23:59:59Z",
    "allowed_currencies": ["USD", "EUR", "INR"],
    "allowed_merchant_categories": ["5411", "5732", "5999"]
  },
  "updated_by": "test"
}'

Python

import requests
import json

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

payload = json.dumps({
  "card_status": "ACTIVE",
  "currency": "USD",
  "transaction_limits": [
    {
      "type": "DAILY",
      "value": 1
    }
  ],
  "authorization_controls": {
    "active_from": "2025-05-01T00:00:00Z",
    "active_to": "2025-12-31T23:59:59Z",
    "allowed_currencies": [
      "USD",
      "EUR",
      "INR"
    ],
    "allowed_merchant_categories": [
      "5411",
      "5732",
      "5999"
    ]
  },
  "updated_by": "test"
})
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("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, "{\n    \"card_status\": \"ACTIVE\",\n    \"currency\": \"USD\",        \n    \"transaction_limits\": [\n        {\n            \"type\": \"DAILY\",\n            \"value\": 1\n        }\n    ],\n    \"authorization_controls\": {\n    \"active_from\": \"2025-05-01T00:00:00Z\",\n    \"active_to\": \"2025-12-31T23:59:59Z\",\n    \"allowed_currencies\": [\"USD\", \"EUR\", \"INR\"],\n    \"allowed_merchant_categories\": [\"5411\", \"5732\", \"5999\"],\n \"updated_by\": \"test\"\n} ");
Request request = new Request.Builder()
  .url("{{baseUrl}}/zoqq/api/v1/card?id={{CardID}}")
  .method("PATCH", 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 data = JSON.stringify({
  "card_status": "ACTIVE",
  "currency": "USD",
  "transaction_limits": [
    {
      "type": "DAILY",
      "value": 1
    }
  ],
  "authorization_controls": {
    "active_from": "2025-05-01T00:00:00Z",
    "active_to": "2025-12-31T23:59:59Z",
    "allowed_currencies": [
      "USD",
      "EUR",
      "INR"
    ],
    "allowed_merchant_categories": [
      "5411",
      "5732",
      "5999"
    ]
  },
  "updated_by": "test"
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/zoqq/api/v1/card?id={{CardID}}',
  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

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

400: Error

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

🧪 Try It Out

🛠 Update Card — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

id:

📝 Request Body

{ "card_status": "ACTIVE", "currency": "USD", "transaction_limits": [ { "type": "DAILY", "value": 1 } ], "authorization_controls": { "active_from": "2025-05-01T00:00:00Z", "active_to": "2025-12-31T23:59:59Z", "allowed_currencies": [ "USD", "EUR", "INR" ], "allowed_merchant_categories": [ "5411", "5732", "5999" ], "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "INTERNATIONAL" }, "updated_by": "test" }

💻 Generated cURL Command

❯

Get Card Transactions

Endpoint

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

Description

This endpoint returns a paginated list of transactions for a specific card, including detailed merchant information, transaction amounts, and status.

📩 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 card

page_num integer

Page number for pagination

page_size integer

Number of items per page

from_created_at string conditional

Start date to filter records created on or after this date. (ISO 8601 date format: YYYY-MM-DD). Must be provided together with to_created_at.

to_created_at string conditional

End date to filter records created on or before this date. (ISO 8601 date format: YYYY-MM-DD). Must be provided together with from_created_at.

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/zoqq/api/v1/card/transaction?id={{CardID}}' \
--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/transaction?id={{CardID}}"

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.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/transaction?id={{CardID}}")
  .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/transaction?id={{CardID}}',
  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

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "has_more": true,
    "items": [
      {
        "acquiring_institution_identifier": "123456",
        "auth_code": "000001",
        "billing_amount": 100,
        "billing_currency": "USD",
        "card_id": "",
        "card_nickname": "string",
        "client_data": "Some client data",
        "digital_wallet_token_id": "",
        "failure_reason": "INSUFFICIENT_FUNDS",
        "lifecycle_id": "",
        "masked_card_number": "************4242",
        "matched_authorizations": [
          "6c2dc266-09ad-4235-b61a-767c7cd6d6ea"
        ],
        "merchant": {
          "category_code": "4829",
          "city": "San Francisco",
          "country": "USA",
          "identifier": "012345678910123",
          "name": "Merchant A",
          "postcode": "94111",
          "state": "CA"
        },
        "network_transaction_id": "3951729271768745",
        "posted_date": "2018-03-22T16:08:02+00:00",
        "retrieval_ref": "909916088001",
        "risk_details": {
          "risk_actions_performed": [
            "TRANSACTION_BLOCKED"
          ],
          "risk_factors": [
            "Suspicious transaction velocity"
          ],
          "three_dsecure_outcome": "AUTHENTICATED"
        },
        "status": "APPROVED",
        "transaction_amount": 100,
        "transaction_currency": "USD",
        "transaction_date": "2018-03-21T16:08:02+00:00",
        "transaction_id": "transactionid",
        "transaction_type": "REFUND"
      }
    ]
  }
}

400: Error

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

🧪 Try It Out

💳 Get Card Transactions — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-request-id:

x-user-id:

Authorization:

🔍 Query Parameters

id:

page_num:

page_siz:

from_created_at:

to_created_at:

💻 Generated cURL Command

❯