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. Money Movement
  • Welcome ๐Ÿ‘‹
  • Get Started
  • Authentication
  • Responses
  • Pagination
  • Auth
    • Token
      POST
  • Businesses
    • List businesses
      GET
    • Create business
      POST
  • Money Movement
    • Create fund
      POST
    • Create payout
      POST
    • Get payout
      GET
    • Create refund
      POST
    • Create transfer
      POST
    • Create withdrawal
      POST
  • Labels
    • List labels
      GET
    • Create label
      POST
  • Transactions
    • List transactions
      GET
    • Get transaction
      GET
    • List wallet transactions
      GET
  • Wallets
    • List wallets
      GET
    • Create wallet
      POST
    • Lookup wallet
      GET
    • Update wallet
      PATCH
    • Get wallet
      GET
    • Get wallet balance
      GET
    • Remove label
      DELETE
    • Assign label
      PUT
  • Wallet Statements
    • Retrieve wallet statement (preview)
  • Webhooks
    • Register webhook endpoint (preview)
    • List webhook endpoints (preview)
  1. Money Movement

Get payout

GET
https://api.staging.vrtx.sa/cl/v1/payouts/{payout_id}
Last modified:2025-12-03 07:59:44
Retrieve a payout by transaction identifier to inspect its final state and metadata.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
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/cl/v1/payouts/b6327558-741e-411c-866b-0eec8ea26005' \
--header 'Authorization: Bearer <token>'

Responses

๐ŸŸข200OK
application/json
Payout returned
Body

Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "sender_account_number": "919900000019",
    "receiver_account_number": "819900000027",
    "amount": "250.00",
    "currency": "SAR",
    "external_reference": "PO-001",
    "purpose": "Vendor settlement",
    "notes": "Urgent",
    "status": "SUCCESS",
    "created_at": "2022-03-10T16:15:50.000Z"
}
๐ŸŸ 401Unauthorized
๐ŸŸ 403Forbidden
๐ŸŸ 404Not Found
Modified atย 2025-12-03 07:59:44
Previous
Create payout
Next
Create refund
Built with