API idempotency
Safely resend API requests without performing the same operation multiple times.
The Evonet API supports idempotency, enabling you to retry a request multiple times while ensuring the action is executed only once. This prevents unintended duplication during failures or retries. For instance, if a timeout error occurs, you can safely resend the same API payment request multiple times, with the assurance that the payment will be processed just once.
Enable Idempotency
To submit a request for idempotent processing, send a request with the idempotency-key: <key> in the HTTP header.
The <key> serves as a unique identifier for the message, limited to 64 characters. We suggest using a UUID. If no response is received (e.g., due to a timeout), you can safely retry the request using the same HTTP header. If the Evonet payments platform has already processed the request, it will return the response from the initial attempt without creating duplicates.
Example
You can generate a unique string as the Idempotency-Key for each request. For example, you could use a UUID (Universally Unique Identifier) like 550e8400-e29b-41d4-a716-446655440000.
Note
Note
If you send the same Idempotency-Key with the same request data multiple times, the server should treat it as a single request and return the same response as the first successful request. This helps prevent duplicate transactions or other unwanted side effects.
Key scope and validity time
Keys are stored at SID (Store ID) level. The system checks that the idempotency keys are unique to the store level. Idempotency keys are valid for a minimum period of 24 hours after first submission.
Updated about 1 month ago