Credit cards

The credit card object and its fields

Credit cards can be associated to orders as their payment sources. Customers can save their credit cards in their wallets (as customer payment sources).

The credit card object

A credit card object is returned as part of the response body of each successful create, list, retrieve, or update API call.

Field

Type

Description

type

string

credit_cards

id

string

The credit card unique identifier

links.self

string

The credit card endpoint URL

attributes.first_name

string

The cardholder's first name

attributes.last_name

string

The cardholder's last name

attributes.full_name

string

Handy attribute that returns the cardholder's first and last name

attributes.number

string

The credit card number

attributes.month

string

The credit card expiration month

attributes.year

string

The credit card expiration year

attributes.valid_thru

string

Handy attribute that returns 'month/year'

attributes.verification_value

string

The credit card verification value (CCV, CVV)

attributes.card_type

string

The credit card type, e.g. visa, master, american_express

attributes.display_number

string

The obscured credit card number. This can be useful to safely display an order's payment source details.

attributes.name

string

Alias for 'display_number'

attributes.display_verification_value

string

The obscured credit card verification value. This can be useful to safely display an order's payment source details.

attributes.fingerprint

string

A universal unique identifier for the credit card

attributes.storage_state

string

The credit card storage state within your vault. Can be one of 'cached', 'retained', or 'redacted'.

attributes.id

string

Unique identifier for the resource (hash).

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add your own identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool or a CRM.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.order

object

The order associated to the credit card. If present, the credit card is set as the order's payment source.

meta.mode

string

The resource environment (can be one of test or live)