Confirm a payment intent

Confirms a payment intent.

SecurityOAuth2 or OAuth2

Request

path Parameters

required

string

The identifier of the payment intent.

header Parameters

Toast-Restaurant-External-ID

required

string

The identifier of the location.

Request Body schema: application/json

customerId	string The unique identifier of the customer record that identifies the customer in the Toast platform. The identifier is used to retrieve the customer's payment methods saved to their profile.
email	string The email address of the customer making the payment. Must consist of the following characters: `a-z, A-Z, 0-9, =, ., -, _, +, @, :, &, ^, %, !, $`. An email address is required for digital or online transactions and must be provided at least once during the payment intent workflow by including it in the request body of the create payment intent, update payment intent, or confirm payment intent request.
paymentMethodId	string The identifier of the payment method associated to this payment intent.
	object Configurable options for each payment method type.
sessionSecret	string A unique and randomized identifier for the payment intent that can be used to create a payment method via iframe and SDKs, or payment methods API.

Responses

200

Successful operation. Payment intent confirmed.

202

Request accepted and is being processed asynchronously.

400

Bad request / Missing required fields.

409

Payment method not found or hasn't been scoped to payment intent.

500

Payment intent could not be updated due to an internal error.

post/v1/payment-intents/{id}/confirm

Request samples

application/json

{"paymentMethodId": "string",
"sessionSecret": "string",
"email": "string",
"customerId": "string",
"paymentMethodOptions": {"card": {"requestIncrementalAuthorization": true,
"requestPartialAuthorization": true
},
"giftCard": {"requestPartialAuthorization": true
},
"giftCardPresent": {"requestPartialAuthorization": true
},
"cardPresent": {"requestPartialAuthorization": true
}
}
}

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_CAPTURE",
"paymentMethodId": "7e532fea-bf6d-46c9-9f75-aee33d514fca",
"creationDate": "2025-02-17T20:33:07.011185Z",
"usage": "ON_SESSION",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"amountDetails": {"tip": 0
},
"email": "string",
"paymentMethodConfigurationDetails": {"id": "22fa8381-1845-4222-9264-102b46a89a96"
},
"standingInstructionType": "UNSCHEDULED",
"offSession": false,
"latestPayment": {"card": {"lastFour": "1111",
"expiry": {"month": "12",
"year": "27"
},
"brand": "VISA"
}
},
"mandateId": "d1bc0870-b8e9-44ee-9a49-7d6c416305cc"
}