Update Payment Tags

Replaces the tags of a payment, in any status.

Use it to label payments for reporting and search after they are sent; Update Payment can change tags only while the payment is
editable. Tags must be enabled on your account, which sets the limits on their number and length. Keys cannot contain spaces.

Requires the Write permission.

The change is applied right after the 204. Read the payment to confirm it.

Errors

  • 400 VALIDATION_ERROR: tags are not enabled on your account, or a tag breaks your limits.
  • 404 NOT_FOUND: the batch or the payment does not exist.
  • 423 NOT_EDITABLE: the batch is archived.
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 Tags.

tags
array of objects
required

The payment's complete set of tags. The list replaces all existing tags; send [] to remove them. Always send this field.

tags*
Responses
204

The operation succeeded. The response has no body.

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