An API call is idempotent if the action is performed only once no matter how many times the API call is retried.

The idempotency helps to avoid unwanted duplication in case of failures and retries. For example, idempotency can guarantee that the payment is charged only once if the same API payment call is retried multiple times in the case of a timeout error.

The Zyla API idempotency is enabled by an idempotency field.

Idempotency fields

The following table lists the idempotency fields of APIs. For details of the idempotency field, see the specific API chapter.