Update a payment intent

Updates details of the payment intent. You can update the following fields:amount, email,customerId, and amountDetails, including tip. If you update the amount, you must also update the amountDetails object to include a tip amount.

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.

Request Body schema: application/json
amount
integer <int32> [ 1 .. 99999999 ]

Amount of the payment to be taken in minor units. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.01 US (e.g., a value of 1) or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

object (AmountDetails)

Details about a tip amount.

customerId
string <uuid>

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 cards 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, =, ., -, _, +, @, :, &, ^, %, !, $.

externalReferenceId
string <uuid>

The unique identifier for the payment intent generated by the restaurant or integration partner. The externalReferenceId can be applied as a payment identifier for a Toast platform check.

Responses
200

Successful operation. Payment intent updated.

400

Bad request / Missing required fields.

409

Payment intent cannot be updated.

500

Internal server error.

post/v1/payment-intents/{id}
Request samples
application/json
{
  • "amount": 1,
  • "email": "string",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "amountDetails": {
    },
  • "externalReferenceId": "b31a2b46-53f5-4ad9-a2e3-1dc38ff564d5"
}
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",
  • "paymentMethodId": "null",
  • "creationDate": "2025-02-17T20:33:07.011185Z",
  • "setupFutureUsage": null,
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "amountDetails": {
    },
  • "email": "string",
  • "paymentMethodConfigurationDetails": {
    },
  • "standingInstructionType": "UNSCHEDULED",
  • "offSession": false,
  • "latestPayment": null
}