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.
Request Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | string | Yes | API version number |
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Yes | Shared X-API key |
| x-product-id | string | Yes | Shared ProductID |
| x-cardholder-id | string | Yes | Cardholder Identification |
| x-wallet-id | string | Yes | Wallet Identification |
| x-card-id | string | Yes | Card Identification |
| x-request-id | string | Yes | Idempotency key for request tracking |
| Content-Type | string | Yes | Must be application/json |
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| amount_limit_period | string | Yes * | Time period limit window for transactions (eg:- "DAY", "WEEK", "MONTH", "YEAR", "LIFETIME", "TRANSACTION".) |
| amount_limit | string | Yes | Limit on amount (eg:- "1000") |
| currency_code | string | Yes | ISO 4217 format currency code (eg:- "USD" , "SGD", "IDR") |
| transaction_type | string | No ** | Type of transaction (eg:- "PURCHASE", "ATM_CASH_WITHDRAWAL") |
*TRANSACTION means limit per transaction. For ATM_CASH_WITHDRAWAL transaction type, only support DAY and MONTH limit. ATM cash withdrawal limits: SGD–Day max 5000 (default 500), Month max 10000; USD–Day max 3750 (default 375), Month max 7500. Defaults apply if no config set
**Defaults to PURCHASE
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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--data '{
"amount_limit_period":"MONTH",
"amount_limit":"1",
"currency_code":"USD"
}'
Response Example
- 200: Success
- 400: Error
{
"status": "Success",
"message": "Card spend limit has been set successfully.",
"code": 200,
"data": []
}
{
"code": 400,
"message": "Error Message",
"status": "error"
}
Get Card Spending Limit​
This API is used to the get the spending limit for a cardholder in the system.
- Endpoint
GET {{baseUrl}}/issuing/api/:version/card/limit
Description
Retrieves the spending limit for a cardholder within the system. This API allows the cardholder to view existing transaction limits, helping monitor spending and manage financial exposure.
Request Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | string | Yes | API version number |
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Yes | Shared X-API key |
| x-product-id | string | Yes | Shared ProductID |
| x-cardholder-id | string | Yes | Cardholder Identification |
| x-wallet-id | string | Yes | Wallet Identification |
| x-card-id | string | Yes | Card Identification |
| x-request-id | string | Yes | Idempotency key for request tracking |
| Content-Type | string | Yes | Must be application/json |
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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
Response Example
- 200: Success
- 400: Error
{
"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"
}
]
}
{
"code": 400,
"message": "Error Message",
"status": "error"
}
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 cardholder within the system. This API allows the cardholder to modify existing transaction limits, helping maintain control over spending and manage financial exposure.
Request Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | string | Yes | API version number |
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Yes | Shared X-API key |
| x-product-id | string | Yes | Shared ProductID |
| x-cardholder-id | string | Yes | Cardholder Identification |
| x-wallet-id | string | Yes | Wallet Identification |
| x-card-id | string | Yes | Card Identification |
| x-request-id | string | Yes | Idempotency key for request tracking |
| Content-Type | string | Yes | Must be application/json |
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| amount_limit_period | string | Yes * | Time period limit window for transactions (eg:- "DAY", "WEEK", "MONTH", "YEAR", "LIFETIME", "TRANSACTION".) |
| amount_limit | string | Yes | Limit on amount (eg:- "1000") |
| currency_code | string | Yes | ISO 4217 format currency code (eg:- "USD" , "SGD", "IDR") |
| transaction_type | string | No ** | Type of transaction (eg:- "PURCHASE", "ATM_CASH_WITHDRAWAL") |
*TRANSACTION means limit per transaction. For ATM_CASH_WITHDRAWAL transaction type, only support DAY and MONTH limit. ATM cash withdrawal limits: SGD–Day max 5000 (default 500), Month max 10000; USD–Day max 3750 (default 375), Month max 7500. Defaults apply if no config set
**Defaults to PURCHASE
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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--data '{
"amount_limit_period":"DAY",
"amount_limit":"1000",
"currency_code":"USD",
"transaction_type": "PURCHASE"
}'
Response Example
- 200: Success
- 400: Error
{
"status": "Success",
"message": "Update card spend limit has been set successfully.",
"code": 200,
"data": []
}
{
"code": 400,
"message": "Error Message",
"status": "error"
}
Delete Card Spending Limit​
This API is used to delete the spending limit for a cardholder in the system.
- Endpoint
DELETE {{baseUrl}}/issuing/api/:version/card/limit
Description
Deletes the spending limit for a cardholder within the system. This API allows the cardholder to remove existing transaction limits, giving full control over spending and transaction flexibility.
Request Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | string | Yes | API version number |
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Yes | Shared X-API key |
| x-product-id | string | Yes | Shared ProductID |
| x-cardholder-id | string | Yes | Cardholder Identification |
| x-wallet-id | string | Yes | Wallet Identification |
| x-card-id | string | Yes | Card Identification |
| x-request-id | string | Yes | Idempotency key for request tracking |
| Content-Type | string | Yes | Must be application/json |
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| amount_limit_period | string | Yes * | Time period limit window for transactions (eg:- "DAY", "WEEK", "MONTH", "YEAR", "LIFETIME", "TRANSACTION".) |
*TRANSACTION means limit per transaction.
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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--data '{
"amount_limit_period":"MONTH"
}'
Response Example
- 200: Success
- 400: Error
{
"status": "Success",
"message": "Card spend limit deleted successfully.",
"code": 200,
"data": []
}
{
"code": 400,
"message": "Error Message",
"status": "error"
}