1. Payouts
Vrtx Docs
  • Welcome đź‘‹
  • Get Started
  • Auth
    • Token
      POST
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get bulk payout status
      GET
    • Get batch report
      GET
    • Get batch report
      GET
  • 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. Payouts

Get payout status

GET
https://api.staging.vrtx.sa/payouts/{payout_id}/status
Last modified:2026-04-16 11:21:19
Retrieves the latest processing status for a payout.
Provide the payoutId received from the Create Payout response to track progress.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

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 GET 'https://api.staging.vrtx.sa/payouts//status' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - example1
{
    "payout_id": "7c5a3d04-3c0e-4fd4-9c5d-4b4f5d6f98b2",
    "status": "PENDING"
}
Modified at 2026-04-16 11:21:19
Previous
Create payout
Next
Get payout status
Built with