Lookup wallet

GET

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

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

Retrieve wallet details by account number or external reference.
This endpoint provides a quick way to locate a wallet linked to a closed-loop business account, using either system-generated identifiers or client-assigned references.

Use this to fetch wallet metadata, confirm linkage to a business, or validate wallet existence before initiating transactions (e.g., payouts or funds).

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/lookup?account_number=054200003017&external_reference=WALLET-Revenue-123&business_id=2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Body

Example

{
    "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"
}

🟠401Unauthorized

🟠403Forbidden

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

Create wallet

Update wallet