Authentication

UnblockPay authenticates your API requests using API keys.

Authentication uses HTTP Basic Auth through the authorization header. You don't need to provide any additional information or password. If the key is missing or incorrect, you'll receive an 401 -Unauthorized status code. We require all requests to use HTTPS and will reject any API requests made over plain HTTP.

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 API Keys, please contact our team.

ExampleCopied!

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' \