Cards

Create Card

Creates a new virtual card for a given cardholder and wallet.

Endpoint

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

Description

This API allows creating a new virtual card under a specific wallet and cardholder. The card is automatically activated upon creation, and 3DS is automatically configured and enrolled to the registered email during card creation. The card can also be marked as a primary card if required. Initial card spending limits are also configured during the card creation process.

Note: For details on default limits, supported limit types, and limit management APIs, refer to the Card Spend Limit section.

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

Unique identifier of the wallet

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

card_type string required

Type of card. Allowed values: virtual.

is_primary string

Optional flag to indicate whether the card should be set as the primary card. Allowed values: true, false.

🧩 Examples

Request Example

cURL

curl --location --request POST \
--url '{{baseUrl}}/issuing/api/:version/card' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
  "card_type":"virtual",
  "is_primary":"true"
}'

Python

import requests
import json

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

payload = json.dumps({
  "card_type": "virtual",
  "is_primary": "true"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  '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)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"card_type\":\"virtual\",\n  \"is_primary\":\"true\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card")
  .method("POST", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .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();

NodeJs

const axios = require('axios');
let data = JSON.stringify({
  "card_type": "virtual",
  "is_primary": "true"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    '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

{
  "status": "Success",
  "message": "Card created and fee processed successfully.",
  "code": 200,
  "data": [
    {
      "cardId": "card-id"
    }
  ]
}

400: Error

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

🧪 Try It Out

💳 Create Card — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-client-id:

x-request-id:

Authorization:

📝 Request Body

{ "card_type": "virtual", "is_primary": "true" }

💻 Generated cURL Command

❯

Get Card List

Retrieves all cards (virtual/physical) linked to a specific wallet and cardholder.

Endpoint

GET {{baseUrl}}/issuing/api/:version/card/list

Description

This API retrieves a list of cards associated with a given cardholder and wallet. It retuens both virtual and physical cards. Use this API to fetch card details like card type, card_id, card_status, and last 4 digits of the card.

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

Unique identifier of the wallet

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

🔍 Query Parameters

page integer

Page number for pagination

size integer

Number of records per page

🧩 Examples

Request Example

cURL

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

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/list"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  '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)

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}}/issuing/api/:version/card/list")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .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();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/list',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    '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

{
  "status": "Success",
  "message": "Card list fetched successfully.",
  "code": 200,
  "data": [
    {
      "cards": [
        {
          "last4": "9546",
          "createdAt": "2025-09-24",
          "cardId": "card-id",
          "cardType": "VIRTUAL",
          "cardStatus": "INACTIVE"
        }
      ],
      "total_count": 1,
      "page": 1,
      "total_pages": 1
    }
  ]
}

400: Error

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

🧪 Try It Out

🧾 Get Card List — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-client-id:

x-request-id:

Authorization:

🔍 Query Parameters (Optional)

❯

💻 Generated cURL Command

❯

Activate Card

Activates a specific physical or virtual card for a cardholder’s wallet.

Endpoint

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

Description

This API is used to activate a card linked to a cardholder and wallet. Cards are typically activated automatically upon creation or assignment. This API is primarily used to reactivate cards that are currently in INACTIVE status.

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

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card to activate

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

Request Example

cURL

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

Python

import requests
import json

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

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  '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)

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}}/issuing/api/:version/card/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-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .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();

NodeJs

const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/activate',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    '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

{
  "status": "Success",
  "message": "Card activated successfully.",
  "code": 200,
  "data": [
    {
      "status": "ACTIVE"
    }
  ]
}

400: Error

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

🧪 Try It Out

⚡ Activate Card — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Get Card Details

Retrieves the details of a specific card (virtual or physical) for a given cardholder and wallet.

Endpoint

GET {{baseUrl}}/issuing/api/:version/card/details

Description

This API fetches detailed information about a card including its type (physical/virtual), status, spend limits, delivery status (for physical cards), and associated truncated card number.

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

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

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

Request Example

cURL

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

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/details"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  '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)

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}}/issuing/api/:version/card/details")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .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();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/details',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    '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

{
  "status": "Success",
  "message": "Card details fetched successfully.",
  "code": 200,
  "data": [
    {
      "printing_state": "REQUESTED_BY_USER",
      "daily_spend_limit": "500000.00",
      "created_at": "2025-09-25T04:34:27",
      "purchase_limit": "500000.00",
      "card_type": "PHYSICAL",
      "is_pin_set": false,
      "total_spend_limit": "",
      "weekly_spend_limit": "",
      "card_delivery_status": "ORDERED",
      "card_is_primary": true,
      "monthly_spend_limit": "2000000.00",
      "card_number_id": "card-number-id",
      "truncated_card_number": "4665********9595",
      "status": "ACTIVE"
    }
  ]
}

400: Error

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

🧪 Try It Out

ℹ️ Get Card Details — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Update Card Status

Updates the status of a specific card (virtual or physical) for a given cardholder and wallet.

Endpoint

PATCH {{baseUrl}}/issuing/api/:version/card/status/update

Description

This API allows you to update the status of a card. Supported statuses: INACTIVE, ACTIVE, LOCKED, LOST, STOLEN, BLOCKED, BLOCKED_BY_FRAUD.

Notes:
- The ACTIVE status can only be updated for cards that are currently in LOCKED status.
- Cards marked as INACTIVE status can be reactivated using the Activate Card API.
- All other card statuses permanently block the card and cannot be reactivated.

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

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card to update status

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

card_status string required

New status of the card. Allowed values: ACTIVE, INACTIVE, LOCKED, LOST, STOLEN, BLOCKED, BLOCKED_BY_FRAUD.

reason string required

Reason for the status update.

🧩 Examples

Request Example

cURL

curl --location --request PATCH \
--url '{{baseUrl}}/issuing/api/:version/card/status/update' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
  "card_status":"INACTIVE",
  "reason":"Your Reason"
}'

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/status/update"

payload = json.dumps({
  "card_status": "INACTIVE",
  "reason": "Your Reason"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  '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)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"card_status\":\"INACTIVE\",\n  \"reason\":\"Your Reason\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/status/update")
  .method("PATCH", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .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();

NodeJs

const axios = require('axios');
let data = JSON.stringify({
  "card_status": "INACTIVE",
  "reason": "Your Reason"
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/status/update',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    '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

{
  "status": "Success",
  "message": "Card status updated successfully.",
  "code": 200,
  "data": [
    {
      "status": "INACTIVE"
    }
  ]
}

400: Error

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

🧪 Try It Out

✏️ Update Card Status — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

📝 Request Body

{ "card_status": "INACTIVE", "reason": "Your Reason" }

💻 Generated cURL Command

❯

Update Card Configuration

Updates the configuration settings of a specific card for a given cardholder and wallet.

Endpoint

PATCH {{baseUrl}}/issuing/api/:version/card/configuration

Description

This API allows you to enable or disable card-present transactions. When enabled (true), the card can be used at a POS/EDC machine (via swipe, insert, or contactless tap) to initiate a transaction. By default, card-present transactions are enabled when a card is created.

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

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card to update

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

card_present_transaction_enabled booleanrequired

Enables or disables card-present transactions. When enabled (true), the card can be used at a POS/EDC machine (via swipe, insert, or contactless tap) to initiate a transaction.

🧩 Examples

Request Example

cURL

curl --location --request PATCH \
--url '{{baseUrl}}/issuing/api/:version/card/configuration' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
  "card_present_transaction_enabled": false
}'

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/configuration"

payload = json.dumps({
  "card_present_transaction_enabled": False
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  '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)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"card_present_transaction_enabled\": false\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/configuration")
  .method("PATCH", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .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();

NodeJs

const axios = require('axios');
let data = JSON.stringify({
  "card_present_transaction_enabled": false
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/configuration',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    '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

{
  "status": "Success",
  "message": "Card configuration updated successfully.",
  "code": 200,
  "data": [
    {
      "card_present_transaction_enabled": false
    }
  ]
}

400: Error

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

🧪 Try It Out

🛠️ Update Card Configuration — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

📝 Request Body

{ "card_present_transaction_enabled": false }

💻 Generated cURL Command

❯

Get Card Configuration

Retrieves the configuration settings of a specific card (virtual or physical) for a given cardholder and wallet.

Endpoint

GET {{baseUrl}}/issuing/api/:version/card/configuration

Description

This API fetches the current configuration of a card including settings such as whether card-present transactions are enabled.

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

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

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

Request Example

cURL

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

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/configuration"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  '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)

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}}/issuing/api/:version/card/configuration")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .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();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/configuration',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    '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

{
  "status": "Success",
  "message": "Card configuration details fetched successfully.",
  "code": 200,
  "data": [
    {
      "card_present_transaction_enabled": false
    }
  ]
}

400: Error

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

🧪 Try It Out

ℹ️ Get Card Configuration — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Get Card Details Token

Retrieves a secure URL containing full card details (card number, expiry, CVV, and cardholder name) for a specific card.

Endpoint

GET {{baseUrl}}/issuing/api/:version/card/token

Description

This API generates a secure tokenized URL that provides the complete card details including card number, expiry date, CVV, and cardholder name. The URL is used for viewing or integrating the card information securely.

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

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

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

Request Example

cURL

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

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/token"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  '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)

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}}/issuing/api/:version/card/token")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .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();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/token',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    '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

{
  "status": "Success",
  "message": "Card details token fetched successfully.",
  "code": 200,
  "data": [
    {
      "url": "url-to-view-card-details"
    }
  ]
}

400: Error

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

🧪 Try It Out

ℹ️ Get Card Details Token — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Assign Physical Card

Assigns a physical card to a cardholder once they receive it and provide required details.

Endpoint

POST {{baseUrl}}/issuing/api/:version/card/assign

Description

This API allows a cardholder to assign a physical card to their profile by providing the required card verification details, such as the last four digits of the card and the assignment code received with the card. Upon successful assignment, the card is automatically activated, and 3D Secure (3DS) is automatically enrolled using the cardholder's registered email address. Initial card spending limits are also configured during the card assignment process.

Note: For details on default limits, supported limit types, and limit management APIs, refer to the Card Spend Limit section.

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

Unique identifier of the wallet

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

last_four_digit string required

Last four digits of the card.

code string required

Card assignment code received with the card.

🧩 Examples

Request Example

cURL

curl --location --request POST \
--url '{{baseUrl}}/issuing/api/:version/card/assign' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
  "last_four_digit": "{{Last4Digit}}",
  "code": "{{Code}}"
}'

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/assign"

payload = json.dumps({
  "last_four_digit": "{{Last4Digit}}",
  "code": "{{Code}}"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  '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)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"last_four_digit\": \"{{Last4Digit}}\",\n  \"code\": \"{{Code}}\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/assign")
  .method("POST", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .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();

NodeJs

const axios = require('axios');
let data = JSON.stringify({
  "last_four_digit": "{{Last4Digit}}",
  "code": "{{Code}}"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/assign',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    '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

{
  "status": "Success",
  "message": "Card created successfully.",
  "code": 200,
  "data": [
    {
      "cardId": "card-id"
    }
  ]
}

400: Error

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

🧪 Try It Out

💳 Assign Physical Card — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-client-id:

x-request-id:

Authorization:

📝 Request Body

{ "last_four_digit": "{{Last4Digit}}", "code": "{{Code}}" }

💻 Generated cURL Command

❯