Idempotent Requests

Overview

Idempotent requests are only available for use on the Create Payment endpoint. This is to help prevent Payers from being charged more than once when submitting a Payment (retry strategies, sending multiple requests, etc).

To submit an idempotent request, you will need to generate a unique Id (UUID v4) and set that as the value in the Idempotency-Key header. This will cache any Payment responses for that request and return the cached response for that specific key.

If a cached response is returned, it will contain an Idempotency-Replay header that is set to true.

🚧

Only POST /Payments Supports Idempotent Requests

If an Idempotency-Key header is passed in for any other endpoint, it will be ignored and no idempotency function will occur.

Try it out