Create fund

POST

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

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

Fund a business account within the closed-loop ecosystem to enable payouts, wallet top-ups, and internal transfers.
When a fund operation occurs, the system creates two synchronized transactions to maintain a transparent ledger:

Debit the Clearance Wallet (indicating an outgoing source of funds).

Credit the Operational Wallet (increasing available funds for usage).

This ensures the closed-loop ledger remains balanced and auditable.

Transaction Flow

Step	Description	Wallet	Direction
1	Debit the clearance wallet to reflect outgoing funds	Clearance	DEBIT (−)
2	Credit the operational wallet to make funds available for use	Operational	CREDIT (+)

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Header Params

Body Params application/jsonRequired

Example

{
    "business_account_number": "950100010020",
    "amount": "1250.50",
    "currency": "SAR",
    "external_reference": "INV-123451122211",
    "notes": "Funding for marketplace float"
}

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/funds' \
--header 'Idempotency-Key: fund-req-123' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "business_account_number": "950100010020",
    "amount": "1250.50",
    "currency": "SAR",
    "external_reference": "INV-123451122211",
    "notes": "Funding for marketplace float"
}'

Responses

🟢201Created

application/json

Created

Body

Example

{
    "id": "a24a1f57-d645-42c6-b67d-b188aaca9cd7",
    "business_account": "054200001011",
    "amount": "1250.50",
    "currency": "SAR",
    "external_reference": "INV-123451111",
    "notes": "Funding for marketplace float",
    "status": "SUCCESS",
    "created_at": "2025-10-25T15:03:54.190Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

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

Create business

Create payout

Create fund

Transaction Flow#

Request

Request Code Samples

Responses

Transaction Flow