Get a payment intent

Returns a payment intent.

SecurityOAuth2
Request
path Parameters
id
required
string <uuid>

The identifier of the payment intent.

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

The identifier of the restaurant location.

Responses
200

Successful operation. Returns the payment intent.

400

Bad request / Missing required fields.

500

Internal server error.

get/v1/payment-intents/{id}
Request samples
curl -i -X GET \
  'https://ws-dev-api.eng.toasttab.com/v1/payment-intents/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "externalReferenceId": "b31a2b46-53f5-4ad9-a2e3-1dc38ff564d5",
  • "sessionSecret": "string",
  • "amount": 0,
  • "currency": "USD",
  • "captureMethod": "MANUAL",
  • "status": "REQUIRES_PAYMENT_METHOD",
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "creationDate": "2023-07-07T14:01:27Z",
  • "setupFutureUsage": "ON_SESSION",
  • "customerId": "string",
  • "amountDetails": {
    },
  • "email": "string",
  • "paymentMethodConfigurationDetails": {
    },
  • "latestPayment": {
    },
  • "offSession": true,
  • "standingInstructionType": "UNSCHEDULED"
}