Idempotency

The NomuPay API supports idempotency. This enables you to send the same request multiple times while only performing the action once. This feature is optional but strongly recommended as it will prevent unwanted duplicates in the system. Every resource has an endpoint to retrieve the response, in case the request is lost (for example, because of a timeout), using the idempotency key.

Please note that the idempotency key is specific to the request itself and not to the resource. To obtain the current status of an operation, you must use the tracking URL included in the response when creating the resource.

How to enable idempotency

To enable idempotency just send a request with the idempotencyKey query parameter for requests supporting it. The key must be a unique identifier of the request.

Key format

The key can be any string between 8 and 50 characters inclusive, but to ensure that it is unique, we recommend generating the key in version 4 UUID.

Scope

The key will be kept in the system for a week. After this period, you may use the key again.

Errors

If the idempotency system is down, we will return a specific error. In this case the client could retry the request without idempotency.