Skip to main content
POST
Generate a scoped Bearer token

Authorizations

X-API-Key
string
header
required

Your merchant API key (mk_...).

X-API-Secret
string
header
required

Your merchant API secret (ms_...). Used only on /auth.

Body

application/json
scopes
enum<string>[]

Subset of your key's scopes to embed in the token.

A permission an API-key token can carry. These are the scopes shown in the dashboard's API Keys screen.

Available options:
pay,
deposit,
balance,
payout,
beneficiaries,
bulk_pay,
payment_links,
team,
webhooks,
settings
Example:
expires_in_hours
integer
default:24
Required range: 1 <= x <= 720
Example:

24

Response

Token issued.

success
boolean
Example:

true

message
string
Example:

"Authentication successful"

request_id
string<uuid>
data
object