Idempotent Request

The Payable API supports idempotency, allowing you to retry a POST request multiple times while only acting once. This feature helps avoid unwanted duplication in case of failures and retries. For example, in the case of a timeout error, it is possible to safely retry sending the same API request multiple times to guarantee that the operation will execute safely only once.

To use this feature, you will include the X-Idempotency-Key header as a part of your request. This key should be something unique, preferably something like a UUID.

When a successful request is made with an idempotency key, we will store the result of that request for 24 hours. If another request is performed within 24 hours using the same credentials and idempotency key, we will return the original response to you.


This feature is independent of the resources and works only for POST operations when the action is completed successfully.

curl --location --request POST '<resource>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: b52fAz9rRUmQNeFbYIp33A' \
--header 'X-Request-Id: ITSBMkBs3kaXaAn25ImSLw' \
--header 'Authorization: Bearer <a_valid_token>'
--data-raw '{
    // some json