Changes the amount, category, jurisdiction, reference ID or tags of a payment that has not been sent.
Requires the Write permission. Send only the fields to change.
When you can update. The payment must be DRAFT, not being sent, in a batch that is not archived, and inside its grace
period: until the end of the day that is your account's grace period (5 days unless agreed otherwise) after the payment was
created. isEditable on the payment tells you whether all of this holds: update only a payment whose isEditable is true.
After the grace period, cancel the payment and create a new one.
Side effects. The payment-changed webhook fires.
Read the payment with Get Payment after updating it to see its new state; do not rely on the response body.
Errors
400 VALIDATION_ERROR: a field is invalid, ortagsbreak your account's limits.404 NOT_FOUND: the batch or the payment does not exist.423 NOT_EDITABLE: the batch is archived or the payment's grace period is over.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
200The payment was updated. Read it with Get Payment to see the result.
