List Wallets

GET

https://api.sandbox.vrtx.sa/customers/

Last modified:2026-08-23 18:31:25

Lists the customers (vrtx wallets) the authenticated business has onboarded.

Results are always scoped to the authenticated business — a business only ever sees the wallets it onboarded.

Sorted by created_at descending. Filters combine with AND: search narrows by free text across external_reference and wallet_account_number (partial match), or resolves a fully-qualified mobile number (9665XXXXXXXX) to its customer, while status narrows by wallet status.

limit above 100 is clamped to 100 rather than rejected. An empty result is a 200 with "data": [] and "total": 0.

mobile_number is always returned masked.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Query Params

Responses

🟢200

application/json

Default Response

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠405

🟠409

🟠410

🟠422

🟠429

🔴500

🔴501

🔴503

🔴504

🔴505

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.sandbox.vrtx.sa/customers/?page=undefined&limit=undefined&search=undefined&status=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        {
            "customer_id": "cust_00154344290ab",
            "external_reference": "E0016",
            "full_name": "Ahmed Al-Otaibi",
            "mobile_number": "9665XXXX4290",
            "status": "active",
            "wallet_account_number": "000100012345",
            "wallet_iban": "SA110292929000000100012345",
            "currency": "SAR",
            "created_at": "2026-06-14T09:32:03.907Z"
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 20,
        "total": 342,
        "total_pages": 18
    }
}

Modified at 2026-08-23 18:31:25

Delete whitelist entries

Get Wallet