Authentication

UnblockPay authenticates your API requests using API keys.

We require all requests to use HTTPS and will reject any API requests made over plain HTTP.

If the key is missing or incorrect, you'll receive an 401 -Unauthorized status code.

Each API key works only with a single environment — if you have a key for sandbox, it won't work for production.

Your API keys provide full access to our APIs so make sure to keep them fully secure. They should never be exposed in any public forums, or broadcasted internally within your organization.

To generate our production API Key, please go to our Dashboard.

Generating your API keys through the Dashboard

Log into our dashboard

Go the “API keys” section

Click on “Generate API key”

Note that the API key will appear only once

Example

Here's a simple example on how to pass in your API key when making requests to any UnblockPay API endpoint:

curl https://api.sandbox.unblockpay.com/payout \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \