<- Payments API

Payments API

Update payment

PUT

 /v2/payments/{payment_id}

Updates a payment with the APPROVED status.

You can update the amount_money and tip_money using this endpoint.

Permissions:PAYMENTS_WRITE

Guide

Update Payment

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

payment_id

string

Required

The ID of the payment to update.

Link to section

Request body

Link to section

payment

The updated Payment object.

Link to section

idempotency_key

string

Required

A unique string that identifies this UpdatePayment request. Keys can be any valid string but must be unique for every UpdatePayment request.

For more information, see Idempotency.

Min Length
1
Max Length
45
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

payment

The updated payment.

Error descriptions