vrtx Docs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
  1. Wallets
  • Welcome 👋
  • Get Started
  • Authentication
  • Responses
  • Pagination
  • Auth
    • Token
      POST
  • Businesses
    • List businesses
      GET
    • Create business
      POST
  • Money Movement
    • Create fund
      POST
    • Create payout
      POST
    • Get payout
      GET
    • Create refund
      POST
    • Create transfer
      POST
    • Create withdrawal
      POST
  • Labels
    • List labels
      GET
    • Create label
      POST
  • Transactions
    • List transactions
      GET
    • Get transaction
      GET
    • List wallet transactions
      GET
  • Wallets
    • List wallets
      GET
    • Create wallet
      POST
    • Lookup wallet
      GET
    • Update wallet
      PATCH
    • Get wallet
      GET
    • Get wallet balance
      GET
    • Remove label
      DELETE
    • Assign label
      PUT
  • Wallet Statements
    • Retrieve wallet statement (preview)
  • Webhooks
    • Register webhook endpoint (preview)
    • List webhook endpoints (preview)
  1. Wallets

Get wallet

GET
https://api.staging.vrtx.sa/cl/v1/wallets/{wallet_id}
Last modified:2025-12-03 07:59:44
Retrieve detailed information about a specific wallet by its unique walletId.
This endpoint returns full metadata including the wallet’s balance, account number, label, currency, linked business, and timestamps.
It’s commonly used to view wallet status, confirm account details before transfers, or display wallet information in dashboards.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.staging.vrtx.sa/cl/v1/wallets/622ea233-3f21-450f-8758-e42cdd4e5e74' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
OK
Body

Example
{
    "id": "622ea233-3f21-450f-8758-e42cdd4e5e74",
    "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
    "name": "Wallet for marketplace revenue",
    "label_id": null,
    "external_reference": "WALLET-Revenue-123",
    "can_overdraft": false,
    "overdraft_limit_minor": 0,
    "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
Previous
Update wallet
Next
Get wallet balance
Built with