Get a customer's payment methods

Returns a list of payment methods saved to a customer record.

SecurityOAuth2
Request
path Parameters
id
required
string <uuid>

The unique identifier of the customer record.

header Parameters
Toast-Restaurant-External-ID
required
string

The identifier of the location.

Toast-Session-Secret
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": 2,
  • "paymentMethods": [
    ]
}