Detach a payment method

Deletes a stored payment method from a customer record. Detaching a payment method is permanent and the payment method cannot be reattached to the customer record.

SecurityOAuth2
Request
path Parameters
id
required
string <UUID>

The unique identifier of the payment method.

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

The identifier of the location.

Request Body schema: application/json
customerId
string

The unique identifier for the customer record that identifies the customer in the Toast platform. The identifier is used to retrieve the payment cards saved to a customer’s profile.

Responses
200

Request processed. The payment method was either deleted (no active mandates associated) or retained with the usage value set to OFF_SESSION (active mandates associated).

400

Invalid request or payment method access validation failed.

403

Your Toast API client does not have permission to detach the saved payment method.

404

The specified saved payment method was not found.

500

Internal server error.

post/v1/payment-methods/{id}/detach
Request samples
application/json
{
  • "customerId": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "type": "string",
  • "card": {
    }
}