1. Auth
Vrtx Docs
  • Welcome đź‘‹
  • Get Started
  • Auth
    • Token
      POST
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get batch report
      GET
  • Transactions
    • Business Accounts
      • Get business account balance
      • Get transaction details
      • List business transactions
  • Business Configurations
    • Get business configurations
      GET
  • Whitelist
    • Add whitelist entries
      POST
    • Get whitelist entries
      GET
    • Delete whitelist entries
      DELETE
Client APIs
Vrtx Closed loopCard Simulator
Client APIs
Vrtx Closed loopCard Simulator
  1. Auth

Token

POST
https://api.staging.vrtx.sa/auth/token
Last modified:2026-04-20 16:15:01
Authenticates a partner using API key and secret, returning a short-lived bearer token scoped to allowed operations.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Default Response
Body

đźź 400Bad Request
đźź 401Unauthorized
đźź 403Forbidden
đźź 404Not Found
đźź 405Method Not Allowed
đźź 409Conflict
đźź 410Gone
đźź 422Unprocessable Entity
đźź 429Too Many Requests
đź”´500Internal Server Error
đź”´501Not Implemented
đź”´503Service Unavailable
đź”´504Gateway Timeout
đź”´505HTTP Version Not Supported
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.staging.vrtx.sa/auth/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "grant_type": "client_credentials",
    "client_id": "partner-sandbox",
    "client_secret": "1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "scope": "write read"
}'
Response Response Example
200 - Example 1
{
    "access_token": "string",
    "token_type": "Bearer",
    "expires_in": 1,
    "scope": "string",
    "issued_at": 0
}
Modified at 2026-04-20 16:15:01
Previous
Get Started
Next
Payouts
Built with