Idempotency Keys

Use this optional header to prevent replay attacks and accidentally repeated transactions

You can prevent duplicate POST requests by including a key that represents the uniqueness of a request, so that no request with the same unique value is attempted more than once.

If a request fails due to a network error, you can safely retry the same request with the same key and guarantee that your request had exactly one effect. When a request is sent with an idempotency key for an already created resource, the response object for the existing resource will be returned.

To perform an idempotent request, add an additional Idempotency-Key header to the request. All requests with the same key will be considered attempts for the same request. It is therefore important that you use unique keys. We suggest using random values, such as V4 UUIDs. These keys are stored for a period of 24 hours.

Currently, idempotency keys are supported on the following endpoints. Idempotency-Key headers provided on other requests will be ignored without error.


Did this page help you?