/
API ReferenceAuthentication

Authentication

Manage API keys, access tokens, and session lifecycle.

POST/v1/auth/token

Exchange API credentials for an access token

Parameters

NameTypeInRequiredDescription
api_keystringbodyRequiredYour API key from the dashboard
api_secretstringbodyRequiredYour API secret
grant_typestringbodyOptionalOAuth grant type. Default: client_credentials

Response Codes

200Token issued successfully401Invalid credentials429Rate limit exceeded
1{
2  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
3  "token_type": "Bearer",
4  "expires_in": 900,
5  "scope": "payments:read payments:write customers:read"
6}
POST/v1/auth/token/refresh

Refresh an expiring access token

Parameters

NameTypeInRequiredDescription
refresh_tokenstringbodyRequiredThe refresh token from the original auth response

Response Codes

200Token refreshed401Invalid or expired refresh token
1{
2  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
3  "token_type": "Bearer",
4  "expires_in": 900,
5  "refresh_token": "wyrr_rt_def456..."
6}
DELETE/v1/auth/token

Revoke an access token

Parameters

NameTypeInRequiredDescription
AuthorizationstringheaderRequiredBearer token to revoke

Response Codes

204Token revoked401Token not found or already revoked
1// 204 No Content