• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
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.

Properties

Name Description
id
string

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

Max Length 64
card_brand
string

Read only The card's brand.

last_4
string

Read only The last 4 digits of the card number.

Max Length 4
exp_month
integer (64-bit)

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

exp_year
integer (64-bit)

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

cardholder_name
string

The name of the cardholder.

Max Length 96
billing_address
Address

The billing address for this card.

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.

Max Length 255
customer_id
string

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

merchant_id
string

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

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.

Max Length 128
enabled
boolean

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

card_type
string

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

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.

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.

Max Length 6
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.

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.