Get card by id
GET
/public/v1/erp/cards/{cardId}Retrieve one card with the actual values of every spend control applied to it.
Returns a single card. The payload is the list entry plus the full configuration behind each control flag: the spend limit amount and period, the allowed or blocked country list, the merchant categories and groups, the top-up and auto-top-up settings, and the ATM rules. Use it when you need to display or audit a card's controls rather than just know they exist.
Path parameters
cardIdstringrequiredthe card identifier (
CA…).
Response
One card object. All list fields, plus:
| Field | Type | Description |
|---|---|---|
purchase_limits | object | { enabled, amount, frequency, limit_currency, number_of_purchases } |
country_limits | object | { restriction_mode, allowed_countries, blocked_countries } |
merchant_category_limits | object | { restriction_type, categories, merchant_groups }: categories carry their MCC codes |
topup_configuration | object | { auto_topup_enabled, auto_topup_amount, frequency } |
auto_top_up_configuration | object | Auto top-up amount and trigger |
atm_configuration | object | { atm_withdrawal_allowed, frequency, max_amount, number_of_withdrawals, limit_per_withdrawal } |
Response schema from the OpenAPI document
| Field | Type | Description |
|---|---|---|
status_code | integer | |
success | boolean | |
data | object | |
id | string | |
card_nickname | string | |
company_name | string | |
status | string | |
card_type | string | |
masked_card_number | string | |
account_external_id | string | |
account_type | string | |
card_currency | string | |
allowed_max_balance | string | |
float_management_enabled | boolean | |
topup_type | string | |
card_replaced | boolean | |
transaction_limits_active | boolean | |
purchase_limits_active | boolean | |
country_limits_active | boolean | |
category_limits_active | boolean | |
atm_withdrawal_allowed | boolean | |
low_balance_notification_active | boolean | |
low_balance_notification_amount | string | |
terminated_at | string | |
activated_at | string | |
issued_at | string | |
auto_top_up_configuration | string | |
created_at | string | |
cardholder | object | |
name | string | |
email | string | |
employee_id | string | |
segments | object[] | |
id | string | |
name | string | |
label | string | |
code | string | |
erp_internal_id | string | |
erp_code | string | |
custom_segments | object[] | |
id | string | |
name | string | |
label | string | |
code | string | |
erp_internal_id | string | |
erp_code | string | |
purchase_limits | object | |
frequency | string | |
amount | string | |
limit_currency | string | |
enabled | boolean | |
number_of_purchases | string | |
country_limits | object | |
restriction_mode | string | |
allowed_countries | object[] | |
blocked_countries | object[] | |
merchant_category_limits | object | |
restriction_type | string | |
categories | object[] | |
merchant_groups | object[] | |
topup_configuration | object | |
auto_topup_enabled | boolean | |
auto_topup_amount | string | |
frequency | string | |
atm_configuration | object | |
atm_withdrawal_allowed | boolean | |
frequency | string | |
max_amount | string | |
number_of_withdrawals | string | |
limit_per_withdrawal | string | |
meta | object | |
request_id | string | |
timestamp | string |
20 nested fields
data.country_limits.allowed_countries[].id | string | |
data.country_limits.allowed_countries[].name | string | |
data.country_limits.allowed_countries[].label | string | |
data.country_limits.allowed_countries[].code | string | |
data.country_limits.allowed_countries[].erp_internal_id | string | |
data.country_limits.allowed_countries[].erp_code | string | |
data.country_limits.blocked_countries[].id | string | |
data.country_limits.blocked_countries[].name | string | |
data.country_limits.blocked_countries[].label | string | |
data.country_limits.blocked_countries[].code | string | |
data.country_limits.blocked_countries[].erp_internal_id | string | |
data.country_limits.blocked_countries[].erp_code | string | |
data.merchant_category_limits.categories[].name | string | |
data.merchant_category_limits.categories[].mcc_codes | string[] | |
data.merchant_category_limits.merchant_groups[].id | string | |
data.merchant_category_limits.merchant_groups[].name | string | |
data.merchant_category_limits.merchant_groups[].label | string | |
data.merchant_category_limits.merchant_groups[].code | string | |
data.merchant_category_limits.merchant_groups[].erp_internal_id | string | |
data.merchant_category_limits.merchant_groups[].erp_code | string |
Errors
401, 403, 404.
401Unauthorized - missing or invalid Bearer token404Not Found - the requested resource does not exist
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.