Create an API key
API keys identify your integration when it calls the Payout API. Create them from the client dashboard before making authenticated requests.
Create the key
1. Open API settings
Sign in to your client dashboard and open API settings.
2. Create a key
Choose Create API key, select Sandbox or Production, then provide a descriptive title. A description is optional. The dashboard sends an OTP by email before creating, regenerating or deleting a key.
3. Save the credentials
Copy the generated API key and secret immediately and store them in a secure server-side secret store. They should not be committed to source control or sent to client-side code.
Authenticate API requests
Use the API key in the X-API-Key header:
Use the base URL configured for your account. The API key type, not a URL convention, isolates sandbox and production data:
The secret is generated with the key but is not sent in the public transfer requests documented here. Keep it protected for credential management and rotation workflows.
Environment selection
Create separate credentials for sandbox and production. Sandbox transfers are simulated and do not call the Runner. Use the sandbox_status field on sandbox transfer requests to choose COMPLETE, FAILED, or TIMEOUT; if omitted, the simulated result is COMPLETE.
Common authentication errors
| Status | Meaning |
|---|---|
401 | The X-API-Key header is missing or the key is invalid. |
403 | The key is valid but cannot perform the requested operation. |