Get customer payment methods

Returns information about payment methods a customer saved for future transactions. For example, a customer might choose to save a credit card as a payment method while making an online purchase.

If your hosted checkout integration uses the Toast platform iframe on your checkout page, the hosted checkout implementation calls this endpoint. Typically, your integration does not directly retrieve stored payment methods.

SecurityOAuth2
Request
path Parameters
id
required
string <uuid>

The unique identifier of the customer record assigned by the Toast platform.

header Parameters
Toast-Restaurant-External-ID
required
string <string>

The identifier of the restaurant location.

Toast-Session-Secret
string <string>

A unique and randomized identifier attached to a payment intent used to retrieve a customer's payment method data.

Responses
200

Successful operation. Returns information about a customer's saved payment methods.

404

The customer record does not exist.

500

Internal server error.

get/v1/customers/{id}/payment-methods
Request samples
curl -i -X GET \
  'https://toast-api-server/v1/customers/{id}/payment-methods' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string' \
  -H 'Toast-Session-Secret: string'
Response samples
application/json
{
  • "results": 0,
  • "paymentMethods": [
    ]
}