Create payout

POST

https://api.staging.vrtx.sa/cl/v1/payouts

Last modified:2025-12-03 07:59:44

Move funds from a business operational account to one or more wallets inside the closed-loop ecosystem.
This API enables businesses to distribute money internally, such as customer rewards, wallet top-ups, or supplier payments, without using any external payment rails.
The source will always be the business’s operational account.

Transaction Flow

Step	Description	Account Type	Direction
1	Debit the business operational account to reflect the outgoing payment	Business	DEBIT (−)
2	Credit the wallet account of the recipient	Wallet	CREDIT (+)

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "source_account_number": "950100010020",
    "destination_account_number": "850100010048",
    "amount": "10.00",
    "currency": "SAR",
    "external_reference": "PO-001357911441",
    "purpose": "Vendor settlement",
    "notes": "Process before noon"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/cl/v1/payouts' \
--header 'Idempotency-Key: payout-req-123' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "source_account_number": "950100010020",
    "destination_account_number": "850100010048",
    "amount": "10.00",
    "currency": "SAR",
    "external_reference": "PO-001357911441",
    "purpose": "Vendor settlement",
    "notes": "Process before noon"
}'

Responses

🟢201Created

application/json

Created

Body

Example

{
    "id": "b6327558-741e-411c-866b-0eec8ea26005",
    "sender_account_number": "054200001011",
    "receiver_account_number": "054200002027",
    "amount": "10.00",
    "currency": "SAR",
    "external_reference": "PO-0013579",
    "purpose": "Vendor settlement",
    "notes": "Process before noon",
    "status": "SUCCESS",
    "created_at": "2025-10-25T14:34:04.254Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-12-03 07:59:44

Create fund

Get payout

Create payout

Transaction Flow#

Request

Request Code Samples

Responses

Transaction Flow