Each API request is associated to one request id. You can find this value in the response headers, under RequestId key. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.
The Paybyrd API supports idempotency for safely retrying HTTP POST requests without accidentally duplicating operations.
This is very handy when no response is received due to a network connection error. Sending an idempotency key will allow you to repeat exactly the same request and obtain the response from the previous one.
To perform an idempotent request, provide an additional idempotency-key header to the request as following:
curl -H 'idempotency-key: a5ce4eb7-86e9-4569-a722-091d06643201'
Paybyrd's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.
An idempotency key is a unique value generated by the consumer which the server uses to recognize subsequent retries of the same request.
Using V4 UUIDs for idempotency keys will guarantee enough entropy and avoid collisions.
Idempotency keys will be removed from the system automatically after 24 hours. If a new request is generated with the same key after this time, a new operation is performed.
Updated 6 months ago