Create refund

POST

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

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

Move funds from one or more wallets back to the business operational account within the closed-loop ecosystem.
This endpoint is used to reverse previous payouts, such as customer refunds or cancelled transfers.

Each refund can optionally link to the original payout transaction for full traceability in the ledger and audit logs.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Created

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.staging.vrtx.sa/cl/v1/refunds' \
--header 'Idempotency-Key: refund-req-123' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "original_transaction_id": "da6d857d-0bbf-411d-9902-ec90e0e92963",
    "amount": "20",
    "external_reference": "REFff-1955555",
    "notes": "Customer refund"
}'

Response Example

201 - RefundResponse

{
    "id": "4e0f5b1f-c449-4083-a408-bfe1355a3b6b",
    "amount": "10.00",
    "currency": "SAR",
    "external_reference": "REF-123456789",
    "original_transaction_reference": "PO-0013579",
    "sender_account_number": "054200002027",
    "receiver_account_number": "054200001011",
    "notes": "Customer refund",
    "status": "SUCCESS",
    "created_at": "2025-10-25T14:35:46.011Z",
    "original_transaction_id": "b6327558-741e-411c-866b-0eec8ea26005",
    "original_transaction_amount": "10.00",
    "total_refunded_amount": "10.00"
}

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

Get payout

Create transfer