The Card object

A debit card on the bank's BIN linked to an account: lifecycle, controls, and the PAN behind a token.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

cardholder_authority_idstringOptional

Example chra_2tVh8nqLxq4GbDe0K1F6S9zRcWm

cardholder_customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

controlsobjectRequired

Controls are the cardholder's spending rules, checked on every authorization.

9 child attributes

allowed_countriesarray of stringsOptional

Empty means any

blocked_mccsarray of stringsOptional

channelsobjectRequired

Channels a card may be used on.

4 child attributes

atmbooleanRequired

contactlessbooleanRequired

ecommercebooleanRequired

posbooleanRequired

daily_limit_amountintegerRequired

merchant_idstringOptional

per_transaction_limit_amountintegerRequired

single_usebooleanOptional

valid_fromstring · date-time or nullOptional

valid_untilstring · date-time or nullOptional

expiry_monthintegerRequired

expiry_yearintegerRequired

facility_idstringOptional

formstringRequired

idstringRequired

Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

last4stringRequired

networkstringRequired

pan_tokenstringRequired

statusstringRequired