vrtx Docs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
  1. Payouts
  • Welcome 👋
  • Get Started
  • Auth
    • Token
      POST
  • Onboarding
    • Start onboarding
      POST
    • Verify onboarding OTP
      POST
    • Resend onboarding OTP
      POST
    • Get session status
      GET
    • Initiate Nafath
      POST
    • Cancels session
      POST
    • Complete customer info
      POST
  • Wallet
    • Change mobile number from profile settings
      • Change mobile number
      • Verify mobile number change OTP
      • Get mobile change status
    • Change mobile number from login screen
      • Change mobile number
      • Verify mobile number change OTP
      • Initiate Nafath
      • Get mobile number change status
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get batch report
      GET
  • Cards
    • Issuance
      • Issue card
      • Get card issuance
      • Complete card issuance
      • Verify card issuance OTP
      • Convert virtual to physical
      • Verify card conversion OTP
    • Management
      • Get card
      • Change card status
      • Set or update card PIN
      • Verify card PIN OTP
      • Activate physical card
      • Verify activation OTP
      • Display sensitive data
      • Verify display sensitive data OTP
  • Transactions
    • Business Accounts
      • Get business account balance
      • Get transaction details
      • List business transactions
    • Wallet Accounts
      • Get wallet balance
      • List wallet transactions
  • cards
    • Initiate card replacement
      POST
    • Verify OTP and complete card replacement
      POST
  1. Payouts

Get payout status

GET
https://api.staging.vrtx.sa/payouts/{payout_id}/status
Last modified:2025-12-03 10:51:05
Retrieves the latest processing status for a payout.
Provide the payoutId received from the Create Payout response to track progress.

Request

Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.staging.vrtx.sa/payouts//status'

Responses

🟢200OK
application/json
Default Response
Body

Examples
{
    "payout_id": "7c5a3d04-3c0e-4fd4-9c5d-4b4f5d6f98b2",
    "status": "PENDING"
}
🟠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
Modified at 2025-12-03 10:51:05
Previous
Create payout
Next
Create bulk payout
Built with