Overview

The Wallets API lets businesses view balances, account details, pending funds, and wallet status. Use wallet details together with transaction and webhook records when reconciling funds.

🔍 Get All Wallets

Retrieve a list of all wallets by sending a request to the get all wallets endpoint. This enables businesses to monitor wallet statuses and balances in real-time. Response Example The response provides an array of wallet objects. Use the balances, account details, status, and timestamps to display wallet state and reconcile incoming funds.

Response

[
  {
    "account_name": "string",
    "account_number": "string",
    "account_type": "string",
    "balance": 100000, // Balance in the smallest currency unit
    "bank_address": "string",
    "bank_code": "string",
    "bank_name": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "id": "wlt_123456789",
    "is_blocked": false,
    "pending_balance": 50000, // Pending balance in the smallest currency unit
    "reference": "string",
    "routing_number": "string",
    "total_received": 1500000, // Total amount received in the smallest currency unit
    "updated_at": "2024-01-02T00:00:00Z"
  }
  // ...other wallets
]

### 🔍 Get Wallet Details

Retrieve a specific wallet with the [get wallet](/api-reference/wallets/get) endpoint.

<ParamField path="id" type="string" required>
  The unique identifier of the wallet to retrieve.
</ParamField>

### 🧪 Simulate a Wallet Credit

In sandbox only, simulate a wallet credit with the [wallet credit](/api-reference/wallets/credit) endpoint. Use this to exercise balance updates and wallet webhook handling during integration testing.

<ParamField path="id" type="string" required>
  The unique identifier of the wallet to credit.
</ParamField>

Get Started

Wallet

Transaction

Customer

Card

Collection

FX

Payout

Webhook Events

🔍 Get All Wallets

​🔍 Get All Wallets

🔍 Get All Wallets