Manage Customer Cards on File

Applies to: Cards APICards API | Customers APICustomers API | Payments APIPayments API

Learn how to use the Cards API to retrieve a stored card, list the cards on file for a customer, and disable a card.

The Cards APICards API provides a set of endpoints you can use to manage credit and debit cards on file. You can retrieve card information using the RetrieveCardRetrieveCard endpoint, list cards on file using the ListCardsListCards endpoint, and disable a card using the DisableCardDisableCard endpoint.

To get information about a card on file, call RetrieveCardRetrieveCard and provide the card ID. If needed, call ListCardsListCards to get the card ID.

To get a customer's cards on file, call ListCardsListCards and provide the customer ID. If you need to get the customer ID, call SearchCustomersSearchCustomers and search by phone number, email address, or other supported attribute.

The following example request uses the customer_id query parameter to get the cards on file for a specified customer. The access token you provide in the request identifies the Square account where the cards are stored.

By default, only enabled cards are returned in the response. To also retrieve disabled cards, include the is_disabled query parameter in the request.

The response returns up to 25 cards. If there are more cards to retrieve, the response includes a cursor. Use this cursor in the cursor field of your next ListCards request to retrieve the next page of results.

To disable a card on file, call DisableCardDisableCard and provide the card ID. If needed, call ListCardsListCards to get the card ID.

After a card is disabled, new CreatePaymentCreatePayment requests that reference the disabled card return an error.

By default, only enabled cards are returned in a ListCards response. To also retrieve disabled cards, include the is_disabled query parameter in the request.

• Cards APICards API
• Create a Card on File from a Payment IDCreate a Card on File from a Payment ID
• Create a Card on File and a PaymentCreate a Card on File and a Payment
• Create a Shared Card on File and Make a PaymentCreate a Shared Card on File and Make a Payment