Authentication

The EukaPay API uses API keys to authenticate requests. You can view and manage your API keys on the EukaPay dashboard.

You will be presented with a private key prefixed by sk_ (secret key for server-side requests).

Please ensure to keep your keys secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.

The API keys are further prefixed with test or live depending on the environment mode you are in.

Test Mode: sk_test_xxx
Live Mode: sk_live_xxx

Use your API key by passing it in the x-api-key header for all API requests.

All API requests must be made over HTTPS. Calls made over plain HTTP or without authentication will fail.

A key is either full access or restricted to a chosen set of permissions. See API Key Permissions for the permissions a restricted key can hold and what a request outside them returns.

Example of request using API key

curl "https://api.eukapay.com/invoices"
-H "x-api-key: sk_test_xxx"

fetch("https://api.eukapay.com/invoices", {
  headers: {
    "x-api-key": "sk_test_xxx",
    .....
  }
})