Update a card top-up target / max balance / top-up frequency
PUT
/public/v1/core/cards/{cardId}Change how much a card may hold and how it is topped up.
Updates a card's funding configuration: the auto top-up amount, the maximum balance it may carry, the top-up frequency and the usage type. Send only the fields you want to change. Cardholders are notified by email when the card is updated.
To change a card's spend limit, use
update_velocity_limit instead.
Path parameters
cardIdstringrequiredCard identifier (
CA…)
Request body
application/jsonrequired
| Field | In | Type | Description |
|---|---|---|---|
cardId | path | string | Card identifier (CA…) |
auto_top_up_amount | body | integer | Amount added automatically on each top-up |
card_usage_type_amount | body | integer | Maximum balance the card may hold |
velocity_period | body | string | Top-up period, e.g. MONTHLY |
card_usage_type | body | string | Funding model, e.g. RELOADABLE |
nickname | body | string | Card name |
{
"card_usage_type_amount": 5000,
"auto_top_up_amount": 1000,
"velocity_period": "MONTHLY",
"card_usage_type": "RELOADABLE"
}Response
200 with message: "Resource updated successfully." and data.card: the updated card.
Response schema from the OpenAPI document
| Field | Type | Description |
|---|---|---|
status_code | integer | |
success | boolean | |
message | string | |
data | object | |
card | object | |
id | integer | |
user_name | string | |
company_name | string | |
user_email | string | |
status | string | |
display_status | string | |
card_type | string | |
nickname | string | |
card_number | string | |
allow_replace_card | boolean | |
card_replaced | boolean | |
velocity_period | string | |
allow_atm | boolean | |
return_card | string | |
shipping_card | string | |
terminated_at | string | |
spend_restriction_type | string | |
last_four | string | |
limit_amount_notification | string | |
card_balance_running_low_notification | boolean | |
allowed_countries_list_active | boolean | |
foreign_entity | boolean | |
atm_restricted_at | string | |
issuer | string | |
allowed_mccs_active | boolean | |
spend_limit_active | boolean | |
atm_limit_active | string | |
auto_top_up_amount | integer | |
auto_load_on_transaction_approval | boolean | |
tokenization_status | string | |
account_type | string | |
account_id | integer | |
currency | string | |
show_pool_balance_to_cardholder | boolean | |
is_manager | string | |
is_account_manager | boolean | |
is_dept_manager | string | |
can_edit_all_time_limit | boolean | |
can_reset_limit | boolean | |
reset_summary | string | |
issued_at | string | |
first_activated_at | string | |
external_id | string | |
replaced_by_card_external_id | string | |
replaced_by_card_id | string | |
card_usage_type | string | |
card_usage_type_amount | integer | |
account_balance | string | |
shipment_tracking | string | |
atm_transactions_limit_active | string | |
transactions_limit_active | boolean | |
atm_transactions_limit | string | |
atm_limit | string | |
department | string | |
location | string | |
division | string | |
project | string | |
shipping_address | string | |
return_address | string | |
card_template | string | |
erp_bank_account | string | |
step_up_auth_delegated_user_profile | string | |
created_at | string | |
shipping_details | object | |
allowed_countries_list | string[] | |
wallets_status | object | |
transactions_limit | object | |
spend_limit | object | |
expense_categories | object[] | |
merchants | object[] | |
user_profile | object | |
card_product | object | |
merchant_groups | object[] | |
advanced_velocity_limits | object[] | |
custom_segments | object[] | |
meta | object | |
request_id | string | |
timestamp | string |
138 nested fields
data.card.shipping_details.method | string | |
data.card.shipping_details.return_address | object | |
data.card.shipping_details.shipping_address | object | |
data.card.wallets_status.apple_pay | boolean | |
data.card.wallets_status.google_pay | boolean | |
data.card.wallets_status.samsung_pay | boolean | |
data.card.transactions_limit.max_amount | integer | |
data.card.transactions_limit.min_amount | integer | |
data.card.transactions_limit.currency | string | |
data.card.transactions_limit.period | string | |
data.card.transactions_limit.frequency | integer | |
data.card.transactions_limit.transaction_scope | string[] | |
data.card.spend_limit.id | integer | |
data.card.spend_limit.name | string | |
data.card.spend_limit.active | boolean | |
data.card.spend_limit.description | string | |
data.card.spend_limit.min_amount | integer | |
data.card.spend_limit.max_amount | integer | |
data.card.spend_limit.currency | string | |
data.card.spend_limit.period | string | |
data.card.spend_limit.limit_type | string | |
data.card.spend_limit.frequency | integer | |
data.card.spend_limit.num_of_days | string | |
data.card.spend_limit.remote_id | string | |
data.card.spend_limit.external_id | string | |
data.card.spend_limit.remaining_balance | integer | |
data.card.spend_limit.remaining_frequency | integer | |
data.card.spend_limit.remote_sync | string | |
data.card.spend_limit.consumed_limit | integer | |
data.card.spend_limit.consumed_frequency | integer | |
data.card.spend_limit.transaction_scope | string[] | |
data.card.spend_limit.remote_data | object | |
data.card.spend_limit.remote_data.id | string | |
data.card.spend_limit.remote_data.name | string | |
data.card.spend_limit.remote_data.type | string | |
data.card.spend_limit.remote_data.group | string | |
data.card.spend_limit.remote_data.active | boolean | |
data.card.spend_limit.remote_data.amount | integer | |
data.card.spend_limit.remote_data.period | string | |
data.card.spend_limit.remote_data.created | string | |
data.card.spend_limit.remote_data.currency | string | |
data.card.spend_limit.remote_data.modified | string | |
data.card.spend_limit.remote_data.frequency | integer | |
data.card.spend_limit.remote_data.description | string | |
data.card.spend_limit.remote_data.effective_to | string | |
data.card.spend_limit.remote_data.program_level | boolean | |
data.card.spend_limit.remote_data.effective_from | string | |
data.card.spend_limit.remote_data.conditions | object[] | |
data.card.spend_limit.remote_data.per_transaction | object | |
data.card.spend_limit.remote_data.transaction_scope | string[] | |
data.card.expense_categories[].id | string | |
data.card.expense_categories[].name | string | |
data.card.expense_categories[].label | string | |
data.card.expense_categories[].code | string | |
data.card.expense_categories[].erp_internal_id | string | |
data.card.expense_categories[].erp_code | string | |
data.card.merchants[].id | integer | |
data.card.merchants[].name | string | |
data.card.user_profile.department_name | string | |
data.card.user_profile.first_name | string | |
data.card.user_profile.last_name | string | |
data.card.user_profile.company_name | string | |
data.card.user_profile.user_name | string | |
data.card.user_profile.system_role_name | string | |
data.card.user_profile.email | string | |
data.card.user_profile.user_email | string | |
data.card.user_profile.external_id | string | |
data.card.user_profile.user_id | integer | |
data.card.user_profile.status | string | |
data.card.user_profile.fullname | string | |
data.card.user_profile.employee_id | string | |
data.card.user_profile.department_id | integer | |
data.card.user_profile.managing_departments | object[] | |
data.card.user_profile.managing_departments[].id | integer | |
data.card.user_profile.managing_departments[].name | string | |
data.card.card_product.id | integer | |
data.card.card_product.name | string | |
data.card.card_product.status | string | |
data.card.card_product.description | string | |
data.card.card_product.pan_format_token | string | |
data.card.card_product.track_format_token | string | |
data.card.card_product.proxy_format_token | string | |
data.card.card_product.remote_id | string | |
data.card.card_product.external_id | string | |
data.card.card_product.notification_template_remote_id | string | |
data.card.card_product.auth_settings_allowed_list_status_active | boolean | |
data.card.card_product.currency_settings | object | |
data.card.card_product.currency_settings.supported_currency | string | |
data.card.card_product.currency_settings.settlement_currency | string | |
data.card.card_product.currency_settings.priority | integer | |
data.card.card_product.currency_settings.status | string | |
data.card.card_product.currency_settings.allow_loads | boolean | |
data.card.card_product.currency_settings.allow_unloads | boolean | |
data.card.card_product.currency_settings.allow_scheme_debit_txn | boolean | |
data.card.card_product.currency_settings.allow_scheme_credit_txn | boolean | |
data.card.card_product.currency_settings.allow_incoming_transfer | boolean | |
data.card.card_product.currency_settings.allow_outgoing_transfer | boolean | |
data.card.card_product.currency_settings.allow_incoming_sweeps | boolean | |
data.card.card_product.currency_settings.allow_outgoing_sweeps | boolean | |
data.card.card_product.currency_settings.allow_initial_load | boolean | |
data.card.card_product.pin_settings | object | |
data.card.card_product.pin_settings.pin_type | string | |
data.card.card_product.pin_settings.pin_length | integer | |
data.card.card_product.pin_settings.pin_retries | integer | |
data.card.merchant_groups[].id | integer | |
data.card.merchant_groups[].name | string | |
data.card.advanced_velocity_limits[].id | string | |
data.card.advanced_velocity_limits[].title | string | |
data.card.advanced_velocity_limits[].limit_by_type | string | |
data.card.advanced_velocity_limits[].active | boolean | |
data.card.advanced_velocity_limits[].amount | integer | |
data.card.advanced_velocity_limits[].currency | string | |
data.card.advanced_velocity_limits[].period | string | |
data.card.advanced_velocity_limits[].remote_linked | string | |
data.card.advanced_velocity_limits[].remote_sync | string | |
data.card.advanced_velocity_limits[].remaining_balance | integer | |
data.card.advanced_velocity_limits[].limit_type | string | |
data.card.advanced_velocity_limits[].issuer | string | |
data.card.advanced_velocity_limits[].external_id | string | |
data.card.advanced_velocity_limits[].effective_from | string | |
data.card.advanced_velocity_limits[].effective_to | string | |
data.card.advanced_velocity_limits[].frequency | integer | |
data.card.advanced_velocity_limits[].remaining_frequency | integer | |
data.card.advanced_velocity_limits[].consumed_limit | integer | |
data.card.advanced_velocity_limits[].consumed_frequency | integer | |
data.card.advanced_velocity_limits[].expense_category_ids | object[] | |
data.card.advanced_velocity_limits[].expense_category_ids[].id | string | |
data.card.advanced_velocity_limits[].expense_category_ids[].name | string | |
data.card.advanced_velocity_limits[].expense_category_ids[].label | string | |
data.card.advanced_velocity_limits[].expense_category_ids[].code | string | |
data.card.advanced_velocity_limits[].expense_category_ids[].erp_internal_id | string | |
data.card.advanced_velocity_limits[].expense_category_ids[].erp_code | string | |
data.card.custom_segments[].id | string | |
data.card.custom_segments[].name | string | |
data.card.custom_segments[].label | string | |
data.card.custom_segments[].code | string | |
data.card.custom_segments[].erp_internal_id | string | |
data.card.custom_segments[].erp_code | string |
Errors
400 (validation failed), 401, 404.
401Unauthorized - missing or invalid Bearer token404Not Found
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.