<- Object

Object

Card

Represents the payment details of a card to be used for payments.

These details are determined by the payment token generated by Web Payments SDK.

Link to section

Properties

Link to section

id

string

Read only Unique ID for this card. Generated by Square.

Link to section

card_brand

string

Read only The card's brand.

Link to section

last_4

string

Read only The last 4 digits of the card number.

Link to section

exp_month

integer(64-bit)

The expiration month of the associated card as an integer between 1 and 12.

Link to section

exp_year

integer(64-bit)

The four-digit year of the card's expiration date.

Link to section

cardholder_name

string

The name of the cardholder.

Link to section

billing_address

The billing address for this card.

Link to section

fingerprint

string

Read only Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.

Link to section

customer_id

string

Required The ID of a customer created using the Customers API to be associated with the card.

Link to section

merchant_id

string

Read only The ID of the merchant associated with the card.

Link to section

reference_id

string

An optional user-defined reference ID that associates this card with another entity in an external system. For example, a customer ID from an external customer management system.

Link to section

enabled

boolean

Read only Indicates whether or not a card can be used for payments.

Link to section

card_type

string

Read only The type of the card. The Card object includes this field only in response to Payments API calls.

Link to section

prepaid_type

string

Read only Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls.

Link to section

bin

string

Read only The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.

Link to section

version

integer(64-bit)

Current version number of the card. Increments with each card update. Requests to update an existing Card object will be rejected unless the version in the request matches the current version for the Card.

Link to section

card_co_brand

string

Read only The card's co-brand if available. For example, an Afterpay virtual card would have a co-brand of AFTERPAY.