Update a payment batch

Path Params
string
required

Must be a UUID. The unique identifier of the payment batch.

Query Params
string

To perform an idempotent request, provide the idempotency_key query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.

Body Params
string
required

The payment batch status to update to. Must be one of [accepted, failed].

string
required

A description of the reason the payment batch failed.

Response

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