Get a setup intent

Returns a setup intent.

SecurityOAuth2
Request
path Parameters
id
required
string <uuid>

The identifier of the setup intent.

Responses
200

Successful operation. Returns the setup intent.

404

Intent expired / Intent does not exist.

500

Internal server error.

get/v1/setup-intents/{id}
Request samples
curl -i -X GET \
  'https://ws-dev-api.eng.toasttab.com/v1/setup-intents/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "sessionSecret": "string",
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "status": "REQUIRES_PAYMENT_METHOD",
  • "usage": "ON_SESSION"
}