Authentication

Omnipay's authentication mechanism relies on an "apiKey" header, which should be passed when making API calls from your server.

Idempotency

Omnipay expects an Idempotency key to be sent in the header of all POST requests. This is to ensure safe retries.

The IdempotencyKey should be a string that is unique for every request, with a length not less than 8 characters and not more than 50 characters.

HTTP statuses

Status Description
200 or 201 Request was successful
400 Bad Request from the client.
401 Unauthorised request
403 Forbidden. The client is not allowed.
404 Not Found. The resource does not exist.
429 Too many requests. Our rate limit is 100 requests per minute
500 Internal Server Error. There is server side error

Amount fields

All amount fields sent to OmniPay are expected to be in kobo.

Date fields

All date fields in filters should be passed as utc datetime string (i.e 2023-12-01T18:22:49.053Z)

Pin creation

When creating pin, it is expected to pass a deviceId and deviceName field in the request body.

Settings.Secure  |  Android Developers

deviceUID | Apple Developer Documentation