Card Spend Limit

Create Card Spending Limit

This API allows you to sets a spending limit for a card of a cardholder in the system.

Endpoint

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

Description

Sets a spending limit for a card of a cardholder within the system. This API allows the cardholder to define maximum transaction amounts, helping control spending and manage financial exposure.

🔗 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

📦 Body Parameters

amount_limit_periodstringrequired

Time period over which the transaction limit is applied. Allowed values: DAY, WEEK, MONTH, YEAR, LIFETIME, TRANSACTION.

Note:

• TRANSACTION represents a per-transaction limit.
  
• Only DAY and MONTH are supported for transaction_type: ATM_CASH_WITHDRAWAL.

amount_limitintegerrequired

Maximum allowed transaction amount for the specified period. Must be a positive integer greater than 0.

currency_codestringrequired

3-letter ISO-4217 code in which the limit is defined.

transaction_typestringrequired

Type of transaction to which the limit applies. Allowed values: PURCHASE, ATM_CASH_WITHDRAWAL.

🧩 Examples

Request Example

cURL

curl --location --request POST \
--url '{{baseUrl}}/issuing/api/:version/card/limit' \
--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 '{
  "amount_limit_period": "MONTH",
  "amount_limit": 100,
  "currency_code": "USD",
  "transaction_type": "ATM_CASH_WITHDRAWAL"
}'

Python

import requests
import json

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

payload = json.dumps({
  "amount_limit_period": "MONTH",
  "amount_limit": 100,
  "currency_code": "USD",
  "transaction_type": "ATM_CASH_WITHDRAWAL"
})
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, "{\n  \"amount_limit_period\": \"MONTH\",\n  \"amount_limit\": 100,\n  \"currency_code\": \"USD\",\n  \"transaction_type\": \"ATM_CASH_WITHDRAWAL\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/limit")
  .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 data = JSON.stringify({
  "amount_limit_period": "MONTH",
  "amount_limit": 100,
  "currency_code": "USD",
  "transaction_type": "ATM_CASH_WITHDRAWAL"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/limit',
  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 spend limit has been set successfully.",
  "code": 200,
  "data": []
}

400: Error

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

🧪 Try It Out

⚙️ Create Card Spending Limit — 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

{ "amount_limit_period": "MONTH", "amount_limit": 100, "currency_code": "USD", "transaction_type": "ATM_CASH_WITHDRAWAL" }

💻 Generated cURL Command

❯

Get Card Spending Limit

This API is used to the get the spending limit for a card of a cardholder in the system.

Endpoint

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

Description

Retrieves the spending limit for a card of a cardholder within the system. This API allows the cardholder to view existing transaction limits, helping monitor spending and manage financial exposure.

🔗 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/limit' \
--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/limit"

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/limit")
  .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/limit',
  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 spending limit fetched successfully.",
  "code": 200,
  "data": [
    {
      "amount_limit": 500000,
      "active": true,
      "amount_limit_period": "DAY",
      "transaction_type": "PURCHASE",
      "currency_code": "USD"
    },
    {
      "amount_limit": 500000,
      "active": true,
      "amount_limit_period": "TRANSACTION",
      "transaction_type": "PURCHASE",
      "currency_code": "USD"
    }
  ]
}

400: Error

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

🧪 Try It Out

📊 Get Card Spending Limit — 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 Spending Limit

This API is used to updates the spending limit for a card of a cardholder in the system.

Endpoint

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

Description

Updates the spending limit for a card of a cardholder within the system. This API allows the cardholder to modify existing transaction limits, helping maintain control over spending and manage financial exposure.

🔗 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

📦 Body Parameters

amount_limit_periodstringrequired

Time period over which the updated transaction limit is applied. Allowed values: DAY, WEEK, MONTH, YEAR, LIFETIME, TRANSACTION.

Note:

• TRANSACTION represents a per-transaction limit.
  
• Only DAY and MONTH are supported for transaction_type: ATM_CASH_WITHDRAWAL.

amount_limitintegerrequired

New transaction limit amount to be applied for the specified period. Must be a positive integer greater than 0. This value will replace the existing limit.

transaction_typestringrequired

Type of transaction to which the limit is being updated. Allowed values: PURCHASE, ATM_CASH_WITHDRAWAL.

🧩 Examples

Request Example

cURL

curl --location --request PATCH \
--url '{{baseUrl}}/issuing/api/:version/card/limit' \
--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 '{
  "amount_limit_period": "MONTH",
  "amount_limit": 1000,
  "transaction_type": "ATM_CASH_WITHDRAWAL"
}'

Python

import requests
import json

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

payload = json.dumps({
  "amount_limit_period": "MONTH",
  "amount_limit": 1000,
  "transaction_type": "ATM_CASH_WITHDRAWAL"
})
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  \"amount_limit_period\": \"MONTH\",\n  \"amount_limit\": 1000,\n  \"transaction_type\": \"ATM_CASH_WITHDRAWAL\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/limit")
  .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({
  "amount_limit_period": "MONTH",
  "amount_limit": 1000,
  "transaction_type": "ATM_CASH_WITHDRAWAL"
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/limit',
  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": "Update card spend limit has been set successfully.",
  "code": 200,
  "data": []
}

400: Error

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

🧪 Try It Out

🛠️ Update Card Spending Limit — 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

{ "amount_limit_period": "MONTH", "amount_limit": 1000, "transaction_type": "ATM_CASH_WITHDRAWAL" }

💻 Generated cURL Command

❯

Delete Card Spending Limit

This API is used to delete the spending limit for a card of a cardholder in the system.

Endpoint

DELETE {{baseUrl}}/issuing/api/:version/card/limit

Description

Deletes the spending limit for a card of a cardholder within the system. This API allows the cardholder to remove existing transaction limits, giving full control over spending and transaction flexibility.

🔗 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

📦 Body Parameters

amount_limit_periodstringrequired

Time period of the transaction limit to be deleted. Allowed values: DAY, WEEK, MONTH, YEAR, LIFETIME, TRANSACTION.

Note:

• TRANSACTION represents a per-transaction limit.
  
• Only DAY and MONTH are supported for transaction_type: ATM_CASH_WITHDRAWAL.

transaction_typestringrequired

Type of transaction to which the limit should be deleted. Allowed values: PURCHASE, ATM_CASH_WITHDRAWAL.

🧩 Examples

Request Example

cURL

curl --location --request DELETE \
--url '{{baseUrl}}/issuing/api/:version/card/limit' \
--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 '{
  "amount_limit_period":"MONTH",
  "transaction_type": "ATM_CASH_WITHDRAWAL"
}'

Python

import requests
import json

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

payload = json.dumps({
  "amount_limit_period": "MONTH",
  "transaction_type": "ATM_CASH_WITHDRAWAL"
})
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("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, "{\n  \"amount_limit_period\":\"MONTH\"\n,\n  \"transaction_type\": \"ATM_CASH_WITHDRAWAL\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/limit")
  .method("DELETE", 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({
  "amount_limit_period": "MONTH",
  "transaction_type": "ATM_CASH_WITHDRAWAL"
});

let config = {
  method: 'delete',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/limit',
  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 spend limit deleted successfully.",
  "code": 200,
  "data": []
}

400: Error

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

🧪 Try It Out

⛔ Delete Card Spending Limit — 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

{ "amount_limit_period": "MONTH", "transaction_type": "ATM_CASH_WITHDRAWAL" }

💻 Generated cURL Command

❯