Authentication

To use the API, merchants must obtain an API key from their personal account. You can retrieve your API key by logging in at: https://dashboard.omypayments.com/. Without a valid API key, all requests will be rejected.

Include the API key in the header of each request as follows:

curl -X GET -H "apiKey: yourApiKey" https://api.omypayments.com/

If the API key is missing, the server will respond with:

{
    "success": false,
    "message": "Missing api key",
    "statusCode": 0
}

Invoice Statuses

• new: Invoice created; awaiting asset selection. (Typically, there is a limited time for asset selection, after which the invoice is canceled.)

• pending: Asset selected; awaiting payment. (Payment must be made within a set timeframe, otherwise the invoice is canceled.)

• rejected: Invoice canceled; payment cannot be made.

• finished: Invoice successfully paid; funds have been credited to the merchant’s account.