Get Wallet Balance

Retrieves the current balance of a user's sub-wallet for a specified currency.

Endpoint

GET {{base_url}}/api/v1/user/subwallet-balance

Headers

Header	Required	Description
`x-merchant-ref`	Yes	Merchant reference used to identify the merchant making the request.

Query Parameters

Parameter	Type	Required	Description
`currency`	string	Yes	Currency of the sub-wallet whose balance you want to retrieve.
`user_ref`	string	Yes	Unique reference identifying the user.
`chain`	string	No	Blockchain network for the wallet. Leave empty if a chain is not required.

Example Request

curl --location -g '{{base_url}}/api/v1/user/subwallet-balance?currency=NGN&user_ref={{vault%3AMerchant-user-ref}}' \
--header 'x-merchant-ref: {{vault:x-merchant-ref}}'

Success Response

{
  "message": "Wallet Balance",
  "data": {
    "wallet_address": "LBWNGN81C4801EE29D43F8A0B2231E967B74550063J",
    "currency": "NGN",
    "available_balance": 20,
    "ledger_balance": 0,
    "chain": "",
    "status": "COMPLETED"
  }
}

Response Fields

Field	Description
`message`	Response message confirming the wallet balance request.
`data.wallet_address`	Address of the user's sub-wallet.
`data.currency`	Currency of the wallet.
`data.available_balance`	Balance currently available for use.
`data.ledger_balance`	Ledger balance recorded for the wallet.
`data.chain`	Blockchain network associated with the wallet. Empty when not applicable.
`data.status`	Status of the balance request.