Update Payment

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, or tags break 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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the batch, as returned by Create Batch.

string
required

ID of the payment, as returned by Create Payment.

Body Params

Body of Update Payment. Send only the fields you want to change.

string

Your own identifier for this payment. Free text, not unique.

string

New amount, as a decimal string in the payment's currency ("125.50").

string
enum

New payment category.

string
enum

New tax jurisdiction. Must be one enabled on your account, or none.

tags
array of objects

Tags for the payment. The list replaces all existing tags; send [] to remove them. Requires tags to be enabled on your account.

tags
Responses
200

The payment was updated. Read it with Get Payment to see the result.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json