Object Index
You are viewing an old version of the API
Card
Object Index
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
|
Read only Unique ID for this card. Generated by Square. |
card_
|
Read only The card's brand. |
last_
|
Read only The last 4 digits of the card number. |
exp_
|
The expiration month of the associated card as an integer between 1 and 12. |
exp_
|
The four-digit year of the card's expiration date. |
cardholder_
|
The name of the cardholder. |
billing_
|
The billing address for this card. |
fingerprint
|
Read only Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. |
customer_
|
Required The ID of a customer created using the Customers API to be associated with the card. |
merchant_
|
Read only The ID of the merchant associated with the card. |
reference_
|
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. |
enabled
|
Read only Indicates whether or not a card can be used for payments. |
card_
|
Read only The type of the card. The Card object includes this field only in response to Payments API calls. |
prepaid_
|
Read only Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls. |
bin
|
Read only The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field. |
version
|
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_
|
Read only The card's co-brand if available. For example, an Afterpay virtual card would have a co-brand of AFTERPAY. |