Card object

The card object represents a payment card attached to a card account. Read more about cards here.

Object Parameters

authorized_user_entity_id

string

The ID of the person entity authorized to use this card

bin

string

The 6 or 8-digit BIN (Bank Identification Number) for the card

card_account_id

string

The ID of the card account

card_authorization_policy_id

string

The ID of the card authorization policy

card_program_id

string

The ID of the card program

created_at

date-time

The creation date of the card

deactivated_at

date-time

The timestamp when the card was deactivated

deactivation_reason

string

The reason for the card deactivation

expiration_month

integer

The expiration month of the card (1-12)

expiration_year

integer

The expiration year of the card (4-digit year, e.g. 2025)

first_activated_at

date-time

The timestamp when the card was first activated

id

string

The ID of the card

inactive_reason

enum

The reason why the card is deactivated. Possible values: deactivated, replaced, account_closed

last_active_at

date-time

Timestamp when the card was last set to active status

last_four_digits

string

The last four digits of the card PAN

last_inactive_at

date-time

Timestamp when the card was last set to deactivated status

last_paused_at

date-time

Timestamp when the card was last set to paused status

manufacturing_details

object

Manufacturing and shipping details for physical cards. This field is null for virtual cards See Manufacturing details sub-object.

original_card_id

string

The ID of the card that this card replaced. Populated on the replacement card

platform_id

string

The ID of the platform that owns this card

replacement_card_id

string

The ID of the card that replaced this one. Populated on the original card after replacement

replacement_reason

enum

The reason this card was replaced. Populated on the original card when it is renewed or replaced. Possible values: renewed, lost, stolen

sequence_number

integer

The sequence number of the card. Starts at 1 for new cards and increments when a card is renewed (same PAN, new expiration). Resets to 1 when a card is replaced (new PAN)

status

enum

The current status of the card. Possible values: active, paused, deactivated

type

string

The form factor of the card. Possible values: virtual, physical