CustomerCards
Create, update, delete, and query the available CustomerCards in Square.
Table Specific Information
Select
The 本製品 uses the Square API to process search criteria that refer to the CustomerId column, while other filters are processed client side within the 本製品. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.
Select all CustomerCards from all customers:
SELECT * FROM CustomerCards
Select all CustomerCards from a specific customer:
SELECT * FROM CustomerCards WHERE CustomerId = 'CBASEPlKoFeu4nWm0MX_oHdklAIgAQ'
Insert
To create a customer card, you will need to specify CustomerId and CardNonce.
INSERT INTO CustomerCards (CardNonce,CustomerId,BillingAddressLine1,BillingAddressLine2,BillingAddressLocality,BillingAddressPostalCode,BillingAddressCountry,CardholderName) VALUES ('fake-card-nonce-ok','CBASEPlKoFeu4nWm0MX_oHdklAIgAQ','500 Electric Ave','Suite 600','New York','94103','US','CardholderName')
Delete
A customer card can be removed by providing the Id and CustomerId.
DELETE FROM CustomerCards WHERE Id = 'eKoFeu4nWm0MX_oed' AND CustomerId = 'CBASEPlKoFeu4nWm0MX_oHdklAIgAQ'
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The card's unique ID, if any. |
CustomerId [KEY] | String | False |
The customer's unique ID. |
CardBrand | String | True |
The card's brand (such as VISA). |
Last4Digits | String | True |
The last 4 digits of the card's number. |
ExpireMonth | Integer | True |
The month of the card's expiration date. This value is always between 1 and 12, inclusive. |
ExpireYear | Integer | True |
The four-digit year of the card's expiration date. |
CardholderName | String | False |
The cardholder name. This value is present only if this object represents a customer's card on file. |
PhoneNumber | String | True |
The customer's phone number. |
Fingerprint | String | True |
The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. |
CardNonce | String | False |
A card nonce representing the credit card to link to the customer. |
BillingAddressLine1 | String | False |
The first line of the address. |
BillingAddressLine2 | String | False |
The second line of the address. |
BillingAddressLine3 | String | False |
The third line of the address. |
BillingAddressLocality | String | False |
The city or town of the address. |
BillingAddressSubLocality | String | False |
A civil region within the address's locality. |
BillingAddressSubLocality2 | String | False |
A civil region within the address's sublocality. |
BillingAddressSubLocality3 | String | False |
A civil region within the address's sublocality_2. |
BillingAddressAdministrativeDistrictLevel1 | String | False |
A civil entity within the address's country. In the US, this is the state. |
BillingAddressAdministrativeDistrictLevel2 | String | False |
A civil entity within the address's administrative_district_level_1. In the US, this is the county. |
BillingAddressAdministrativeDistrictLevel3 | String | False |
A civil entity within the address's administrative_district_level_2. |
BillingAddressPostalCode | String | False |
The address's postal code. |
BillingAddressCountry | String | False |
The address's country, in ISO 3166-1-alpha-2 format. |
BillingAddressFirstName | String | False |
Optional first name when it's representing recipient. |
BillingAddressLastName | String | False |
Optional last name when it's representing recipient. |
BillingAddressOrganization | String | False |
Optional organization name when it's representing recipient. |