Represents the payment details of a card to be used for payments.
<- Object
Object
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.
The expiration month of the associated card as an integer between 1 and 12.
The billing address for this card. US
postal codes can be provided as a 5-digit zip code or 9-digit ZIP+4 (example: 12345-6789
). For a full list of field meanings by country, see Working with Addresses.
Read only Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
Required The ID of a customer to be associated with the card.
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.
Read only The type of the card. The Card object includes this field only in response to Payments API calls.
Read only The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.
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.
Read only The card's co-brand if available. For example, an Afterpay virtual card would have a co-brand of AFTERPAY.
Read only An alert from the issuing bank about the card status. Alerts can indicate whether future charges to the card are likely to fail. For more information, see Manage Card on File Declines.
This field is present only if there's an active issuer alert.
Read only The timestamp of when the current issuer alert was received and processed, in RFC 3339 format.
This field is present only if there's an active issuer alert.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00