Get a payment intent

Returns a payment intent.

SecurityOAuth2
Request
path Parameters
id
required
string <uuid>

The identifier of the payment intent.

query Parameters
expand[]
Array of strings <= 10 items

Attributes to inline in the response. Repeat the parameter once per value; a comma-separated list is not accepted. Each value must name an attribute marked expandable on the response schema.

The only expandable attribute is latestPayment, which returns an ExpandedPayment carrying the payment's id and amountRefunded, for the CARD_PRESENT, GIFT_CARD_PRESENT, and GIFT_CARD payment method types.

An unrecognized value is rejected with a 400. A recognized value that does not apply to the payment method type on the payment intent is accepted and ignored, so a caller handling mixed traffic can send a stable expand[] value without first inspecting the payment method.

Example: expand[]=latestPayment
header Parameters
Toast-Restaurant-External-ID
required
string <string>

The identifier of the 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}?expand%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "id": "f8450373-f2a6-4211-8064-55b57f46c57e",
  • "externalReferenceId": "b31a2b46-53f5-4ad9-a2e3-1dc38ff564d5",
  • "sessionSecret": "string",
  • "amount": 1,
  • "currency": "USD",
  • "captureMethod": "MANUAL",
  • "status": "REQUIRES_PAYMENT_METHOD",
  • "creationDate": "2025-02-17T20:33:07.011185Z",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "amountDetails": {
    },
  • "email": "string",
  • "paymentMethodConfigurationDetails": {
    },
  • "standingInstructionType": "UNSCHEDULED",
  • "offSession": false,
  • "latestPayment": null,
  • "mandateId": null
}