Skip to main content

Full instrument details

​
id
string<uuid>
required

Unique instrument identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
merchant_id
string
required

Merchant that owns the instrument

Example:

"merch_123456789"

​
holder_id
string
required

Holder ID associated with the instrument

Example:

"holder_123456789"

​
type
required

Credit or debit card

Allowed value: "card"
Example:

"card"

​
payment_method
required
deprecated

Credit or debit card

Allowed value: "card"
Example:

"card"

​
holder_type
required

End customer

Allowed value: "CUSTOMER"
Example:

"CUSTOMER"

​
status
required

Instrument has been created but not yet activated

Allowed value: "CREATED"
Example:

"ACTIVE"

​
created_at
string<date-time>
required

Timestamp when the instrument was created

Example:

"2024-01-01T00:00:00.000Z"

​
updated_at
string<date-time>
required

Timestamp of the last update to the instrument

Example:

"2024-01-01T00:00:00.000Z"

​
future_usage

Stored for future merchant-initiated use without a fixed schedule

Allowed value: "unscheduled_card_on_file"
Example:

"unscheduled_card_on_file"

​
display
object
deprecated

Deprecated, use card. Masked display information for card instruments

​
card
object

Card details of the instrument. last4, funding, issuer and issuer_country describe the real card; values that are unknown, or that we only hold for a device token, are null. For Apple Pay and Google Pay, expiry_month and expiry_year are the wallet device token's expiry, since wallets never share the real card's. Absent for instruments that are not card-backed (e.g. iban).