Get the default payment method for a customer

Returns the default payment method for a customer.

SecurityOAuth2
Request
path Parameters
contextName
required
string

The unique integration provided context name for the default payment method.

Example: checkout
id
required
string <uuid>

The unique identifier of the customer record.

Example: 8dce2c23-283d-4a2a-8a11-d868a92a42d2
header Parameters
Toast-Restaurant-External-ID
required
string <uuid>

The identifier of the location.

Example: 8dce2c23-283d-4a2a-8a11-d868a92a42d2
Toast-Session-Secret
string

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

Example: session-secret
Responses
200

Successful operation. Returns information about a customer's default payment method.

401

Your client is not authorized to use the API endpoint.

403

Your client is not authorized to use the API endpoint.

404

The customer record does not exist.

500

Internal server error.

get/v1/customers/{id}/payment-methods/defaults/{contextName}
Request samples
curl -i -X GET \
  'https://toast-api-server/v1/customers/{id}/payment-methods/defaults/{contextName}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: 8dce2c23-283d-4a2a-8a11-d868a92a42d2' \
  -H 'Toast-Session-Secret: session-secret'
Response samples
application/json
{
  • "paymentMethodId": "579adc3e-49b6-4501-befd-b900b99575f5",
  • "contextName": "checkout"
}