Create withdrawal

POST

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

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

Withdraw funds from a business operational account or a wallet to the clearance wallet, representing settlement or reconciliation outside the closed-loop system.

This operation is a virtual ledger adjustment and is typically used to align internal balances with real-world settlement movements or bank reconciliations.

Transaction Flow

Step	Description	Account	Direction
1	Debit the source account (wallet or operational)	Business / Wallet	DEBIT (−)
2	Credit the WORLD pseudo-account to reflect money leaving the ecosystem	Clearance Wallet	CREDIT (+)

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Header Params

Body Params application/jsonRequired

Example

{
    "source_account_number": "088400008012",
    "amount": "100.00",
    "currency": "SAR",
    "external_reference": "WD-00123452222",
    "purpose": "Cash-out",
    "notes": "Send to settlement account"
}

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/withdrawals' \
--header 'Idempotency-Key: withdraw-req-123' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "source_account_number": "088400008012",
    "amount": "100.00",
    "currency": "SAR",
    "external_reference": "WD-00123452222",
    "purpose": "Cash-out",
    "notes": "Send to settlement account"
}'

Responses

🟢201Created

application/json

Created

Body

Example

{
    "id": "630a552d-97e3-4ae0-8dc9-c373ee1fd86a",
    "source_account_number": "054200001011",
    "amount": "10.00",
    "currency": "SAR",
    "external_reference": "WD-0012345",
    "purpose": "Cash-out",
    "notes": "Send to settlement account",
    "status": "SUCCESS",
    "created_at": "2025-10-25T14:42:27.201Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

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

Create transfer

List labels

Create withdrawal

Transaction Flow#

Request

Request Code Samples

Responses

Transaction Flow