Transaction Idempotency

Understanding Idempotency

The internet is good, but it's not always that reliable because if the network is disrupted, a resource may be called multiple times. Non-idempotent operations in this scenario can have significant unintended consequences by creating additional resources or changing them unexpectedly.

The API supports idempotency to let you safely retry requests without accidentally performing the same operation twice.

What is an Idempotency Key

An idempotency key is a unique value generated by the client and used by our servers to identify retries of the same request. It is up to you how you generate unique keys, but we recommend using V4 UUIDs or another random string with enough entropy to avoid collisions. Idempotency keys can have a maximum length of 255 characters. Once a response to your API request has been generated, we save it.

How to use Idempotency

To perform an idempotent request, provide an additional Idempotency-Key: <key> header to the request.