You are viewing an old version of the API

All Versions

Create customer card

Adds a card on file to an existing customer.

As with charges, calls to CreateCustomerCard are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the first call.

Required permissions: CUSTOMERS_WRITE

Open in API Explorer

Path Parameters

Name	Description
`customer_id string` Required	The Square ID of the customer profile the card is linked to.

Request Body

Name	Description
`card_nonce string` Required	A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See Embedding the payment form for more information. NOTE: Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card.
`billing_address Address`	Address information for the card on file. Only the `postal_code` field is required for payments in the US and Canada.
`cardholder_name string`	The full name printed on the credit card.
`verification_token string`	An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.

Response Fields

Name	Description
`errors Error [ ]`	Any errors that occurred during the request.
`card Card`	The created card on file.

Error Descriptions


                      
  
  
                        CARD_EXPIRED

The card issuer declined the request because the card is expired.


                      
  
  
                        CARD_PROCESSING_NOT_ENABLED

403 Forbidden - the location provided in the API call is not enabled for credit card processing.


                      
  
  
                        CARD_TOKEN_EXPIRED

The provided card token (nonce) has expired.


                      
  
  
                        CARD_TOKEN_USED

The provided card token (nonce) was already used to process payment.


                      
  
  
                        INVALID_CARD

The credit card cannot be validated based on the provided details.


                      
  
  
                        INVALID_CARD_DATA

Generic error - the provided card data is invalid.


                      
  
  
                        INVALID_EXPIRATION

The expiration date for the payment card is invalid. For example, it indicates a date in the past.


                      
  
  
                        UNSUPPORTED_ENTRY_METHOD

The entry method for the credit card (swipe, dip, tap) is not supported.


                      
  
  
                        VERIFY_AVS_FAILURE

402 Request failed - the AVS could not be verified.


                      
  
  
                        VERIFY_CVV_FAILURE

402 Request failed - the CVV could not be verified.

Examples

All Versions

curl https://connect.squareup.com/v2/customers/customer_id0/cards \
  -X POST \
  -H 'Square-Version: 2020-06-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "card_nonce": "YOUR_CARD_NONCE",
    "billing_address": {
      "address_line_1": "500 Electric Ave",
      "address_line_2": "Suite 600",
      "locality": "New York",
      "administrative_district_level_1": "NY",
      "postal_code": "10003",
      "country": "US"
    },
    "cardholder_name": "Amelia Earhart"
  }'

{
  "card": {
    "id": "icard-card_id",
    "card_brand": "VISA",
    "last_4": "1111",
    "exp_month": 11,
    "exp_year": 2018,
    "cardholder_name": "Amelia Earhart",
    "billing_address": {
      "address_line_1": "500 Electric Ave",
      "address_line_2": "Suite 600",
      "locality": "New York",
      "administrative_district_level_1": "NY",
      "postal_code": "10003",
      "country": "US"
    }
  }
}