To make a request idempotent, add the header
X-Payout-Idempotency to the request and pass an idempotency key against it.
An idempotency key is a unique value generated by you. Our servers use this key to recognize subsequent retries of the same request.
The idempotency key (4-36 characters) can only contain alphabets, numbers, hyphens, underscores and space. For example,
53cda91c-8f81-4e77-bbb9-7388f4ac6bf4. We recommend you generate the key using a version 4 (random) UUID generator.
Currently, idempotency is supported only on the Create Payout API and the Composite APIs.
- When retrying a request, the request body must be the same as the first request for idempotency to work. A different payload will be rejected as a
- The idempotency key in retries must be the same as the original request.
- Use unique idempotency keys for each unique request.