Retrieve all cards attributes / top-up targets
/public/v1/core/cardsList cards with the operational attributes used by card-management screens.
Returns a paginated list of cards with their cardholder, status, type and top-up
settings. This is the operational view of a card, as opposed to
GET /public/v1/erp/cards, which is the accounting view with cost-allocation
segments and control flags. Prefer the ERP endpoint for sync and reporting; use this one when you are
about to act on a card through the write endpoints below.
Results are scoped to what the authenticated user is permitted to see, which may be narrower than the whole company.
Query parameters
pageintegerPage number, 1-based. Default
1Example
1page_sizeintegerRecords per page. Default
20(also accepted aslimit)limitintegerExample
5
Response
One object.
| Field | Type | Description |
|---|---|---|
cards[] | array | { id, nickname, card_number, card_type, status, display_status, user_name, user_email, company_name, velocity_period, allow_atm, allow_replace_card, card_replaced, return_card } |
page_info | object | { current_page, per_page, total_entries, total_pages, next_page, previous_page, offset } |
Response schema from the OpenAPI document
| Field | Type | Description |
|---|---|---|
status_code | integer | |
success | boolean | |
data | object | |
cards | 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 | string | |
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 | string | |
allowed_countries_list_active | string | |
foreign_entity | boolean | |
atm_restricted_at | string | |
issuer | string | |
allowed_mccs_active | string | |
spend_limit_active | string | |
atm_limit_active | boolean | |
auto_top_up_amount | string | |
auto_load_on_transaction_approval | boolean | |
tokenization_status | string | |
account_type | string | |
account_id | string | |
currency | string | |
show_pool_balance_to_cardholder | boolean | |
is_manager | string | |
is_account_manager | string | |
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 | string | |
account_balance | string | |
shipment_tracking | string | |
spend_limit | string | |
atm_limit | string | |
shipping_address | string | |
card_template | string | |
erp_bank_account | string | |
step_up_auth_delegated_user_profile | string | |
created_at | string | |
shipping_details | object | |
wallets_status | object | |
user_profile | object | |
advanced_velocity_limits | object[] | |
atm_transactions_limit_active | string | |
transactions_limit_active | boolean | |
atm_transactions_limit | string | |
transactions_limit | object | |
page_info | object | |
current_page | integer | |
per_page | integer | |
total_entries | integer | |
next_page | integer | |
previous_page | string | |
offset | integer | |
total_pages | integer | |
meta | object | |
request_id | string | |
timestamp | string |
55 nested fields
data.cards[].shipping_details.method | string | |
data.cards[].shipping_details.return_address | object | |
data.cards[].shipping_details.shipping_address | object | |
data.cards[].wallets_status.apple_pay | boolean | |
data.cards[].wallets_status.google_pay | boolean | |
data.cards[].wallets_status.samsung_pay | boolean | |
data.cards[].user_profile.department_name | string | |
data.cards[].user_profile.first_name | string | |
data.cards[].user_profile.last_name | string | |
data.cards[].user_profile.company_name | string | |
data.cards[].user_profile.user_name | string | |
data.cards[].user_profile.system_role_name | string | |
data.cards[].user_profile.email | string | |
data.cards[].user_profile.user_email | string | |
data.cards[].user_profile.external_id | string | |
data.cards[].user_profile.user_id | integer | |
data.cards[].user_profile.status | string | |
data.cards[].user_profile.fullname | string | |
data.cards[].user_profile.employee_id | string | |
data.cards[].user_profile.department_id | integer | |
data.cards[].user_profile.managing_departments | object[] | |
data.cards[].user_profile.managing_departments[].id | integer | |
data.cards[].user_profile.managing_departments[].name | string | |
data.cards[].advanced_velocity_limits[].id | string | |
data.cards[].advanced_velocity_limits[].title | string | |
data.cards[].advanced_velocity_limits[].limit_by_type | string | |
data.cards[].advanced_velocity_limits[].active | boolean | |
data.cards[].advanced_velocity_limits[].amount | integer | |
data.cards[].advanced_velocity_limits[].currency | string | |
data.cards[].advanced_velocity_limits[].period | string | |
data.cards[].advanced_velocity_limits[].remote_linked | string | |
data.cards[].advanced_velocity_limits[].remote_sync | string | |
data.cards[].advanced_velocity_limits[].remaining_balance | integer | |
data.cards[].advanced_velocity_limits[].limit_type | string | |
data.cards[].advanced_velocity_limits[].issuer | string | |
data.cards[].advanced_velocity_limits[].external_id | string | |
data.cards[].advanced_velocity_limits[].effective_from | string | |
data.cards[].advanced_velocity_limits[].effective_to | string | |
data.cards[].advanced_velocity_limits[].frequency | integer | |
data.cards[].advanced_velocity_limits[].remaining_frequency | integer | |
data.cards[].advanced_velocity_limits[].consumed_limit | integer | |
data.cards[].advanced_velocity_limits[].consumed_frequency | integer | |
data.cards[].advanced_velocity_limits[].expense_category_ids | object[] | |
data.cards[].advanced_velocity_limits[].expense_category_ids[].id | string | |
data.cards[].advanced_velocity_limits[].expense_category_ids[].name | string | |
data.cards[].advanced_velocity_limits[].expense_category_ids[].label | string | |
data.cards[].advanced_velocity_limits[].expense_category_ids[].code | string | |
data.cards[].advanced_velocity_limits[].expense_category_ids[].erp_internal_id | string | |
data.cards[].advanced_velocity_limits[].expense_category_ids[].erp_code | string | |
data.cards[].transactions_limit.max_amount | integer | |
data.cards[].transactions_limit.min_amount | integer | |
data.cards[].transactions_limit.currency | string | |
data.cards[].transactions_limit.period | string | |
data.cards[].transactions_limit.frequency | integer | |
data.cards[].transactions_limit.transaction_scope | string[] |
Errors
401.
401Unauthorized - missing or invalid Bearer token
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.