List wallets

GET

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

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

Retrieve all wallets available in the closed-loop ecosystem.
You can optionally filter wallets by business, status, or label.

If no filters are provided, the endpoint returns all wallets in the system (paginated).
This endpoint is ideal for building admin dashboards, verifying wallet existence, or managing wallet states across multiple businesses.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.staging.vrtx.sa/cl/v1/wallets?business_id=85fee10b-e47f-46c6-b5c3-e0d34c5060b3&status=ACTIVE&label=Vendor settlement&wallet_kind=OPERATIONAL&limit=50&cursor=eyJvZmZzZXQiOiI4NGFmIn0=' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Body

Example

{
    "items": [
        {
            "id": "c679a509-ede8-4dce-8b02-f2323b2e0299",
            "business_id": "85fee10b-e47f-46c6-b5c3-e0d34c5060b3",
            "name": "Operational Wallet",
            "can_overdraft": false,
            "status": "ACTIVE",
            "account_number": "010300006011",
            "currency": "SAR",
            "balance": "0.00",
            "created_at": "2025-10-25T12:35:16.446Z",
            "updated_at": "2025-10-25T12:35:16.446Z"
        },
        {
            "id": "16fc1ee7-3728-4fd2-bb2e-425d04dfd07c",
            "business_id": "85fee10b-e47f-46c6-b5c3-e0d34c5060b3",
            "name": "Clearing Wallet SAR",
            "external_reference": "clearing-sar",
            "can_overdraft": true,
            "status": "ACTIVE",
            "account_number": "010300006029",
            "currency": "SAR",
            "balance": "0.00",
            "created_at": "2025-10-25T12:35:16.446Z",
            "updated_at": "2025-10-25T12:35:16.446Z"
        },
        {
            "id": "ca3e06bc-4581-431d-98e7-bfe63b2c3e05",
            "business_id": "84a86c0f-39bb-41e6-a531-7065a32b990a",
            "name": "Operational Wallet",
            "can_overdraft": false,
            "status": "ACTIVE",
            "account_number": "009200005016",
            "currency": "SAR",
            "balance": "0.00",
            "created_at": "2025-10-25T11:02:50.415Z",
            "updated_at": "2025-10-25T11:02:50.415Z"
        },
        {
            "id": "6b69e92b-cbc2-4577-9256-17c21df93fd1",
            "business_id": "84a86c0f-39bb-41e6-a531-7065a32b990a",
            "name": "Clearing Wallet SAR",
            "external_reference": "clearing-sar",
            "can_overdraft": true,
            "status": "ACTIVE",
            "account_number": "009200005024",
            "currency": "SAR",
            "balance": "0.00",
            "created_at": "2025-10-25T11:02:50.415Z",
            "updated_at": "2025-10-25T11:02:50.415Z"
        },
        {
            "id": "50b1e36f-5efa-41ad-949a-d4c307041bb4",
            "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
            "name": "Marketplace Wallet 11982",
            "external_reference": "WALLET-MP-11982",
            "can_overdraft": false,
            "status": "ACTIVE",
            "account_number": "054200004015",
            "currency": "SAR",
            "balance": "0.00",
            "created_at": "2025-10-25T09:28:47.949Z",
            "updated_at": "2025-10-25T09:37:39.091Z"
        },
        {
            "id": "89dc25e6-1c92-4fc7-b533-1f1c76c13f58",
            "business_id": "9fa5cea8-6edb-4196-800f-8809e08f1365",
            "name": "Clearing Wallet SAR",
            "external_reference": "clearing-sar",
            "can_overdraft": true,
            "status": "ACTIVE",
            "account_number": "099800003032",
            "currency": "SAR",
            "balance": "-1000.00",
            "created_at": "2025-10-25T07:21:02.725Z",
            "updated_at": "2025-10-25T07:48:18.345Z"
        },
        {
            "id": "1184dd97-0a2f-410f-9c3c-3e3da3aa778d",
            "business_id": "9fa5cea8-6edb-4196-800f-8809e08f1365",
            "name": "Operational Wallet",
            "can_overdraft": false,
            "status": "ACTIVE",
            "account_number": "099800003024",
            "currency": "SAR",
            "balance": "1000.00",
            "created_at": "2025-10-25T07:21:02.725Z",
            "updated_at": "2025-10-25T07:48:18.345Z"
        },
        {
            "id": "622ea233-3f21-450f-8758-e42cdd4e5e74",
            "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
            "name": "Wallet for marketplace revenue",
            "external_reference": "WALLET-Revenue-123",
            "can_overdraft": false,
            "status": "ACTIVE",
            "account_number": "054200003017",
            "currency": "SAR",
            "balance": "0.00",
            "created_at": "2025-10-25T07:13:51.196Z",
            "updated_at": "2025-10-25T07:13:51.196Z"
        },
        {
            "id": "1e410c63-5614-4e7c-8d4a-b872871ac92a",
            "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
            "name": "Wallet for merchant 1920",
            "can_overdraft": true,
            "status": "ACTIVE",
            "account_number": "054200002027",
            "currency": "SAR",
            "balance": "1.00",
            "created_at": "2025-10-25T05:59:11.279Z",
            "updated_at": "2025-10-25T09:03:48.612Z"
        },
        {
            "id": "75304aff-2adc-4964-9ba8-a67eba92d311",
            "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
            "name": "Wallet for merchant 1909",
            "can_overdraft": false,
            "status": "ACTIVE",
            "account_number": "054200002019",
            "currency": "SAR",
            "balance": "4.50",
            "created_at": "2025-10-25T05:58:37.332Z",
            "updated_at": "2025-10-25T08:51:20.005Z"
        }
    ],
    "next_cursor": "MjAyNS0xMC0yNVQwNTo1ODozNy4zMzIwMzVafDc1MzA0YWZmLTJhZGMtNDk2NC05YmE4LWE2N2ViYTkyZDMxMQ",
    "has_next": true
}

🟠401Unauthorized

🟠403Forbidden

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

List wallet transactions

Create wallet