List Wallet

Retrieve the wallets associated with a specific user under your merchant account.

This endpoint allows you to view the wallets created for a user and retrieve important wallet information such as the wallet ID, supported currency, available balance, ledger balance, chain, and wallet status.

You can use this information to determine the funds currently available to the user, track wallet balances, and identify the wallets that can be used for supported wallet operations.

Request

To retrieve the wallets associated with a user, send a GET request using the user's user_ref as a query parameter.

GET {{base_Url}}/api/v1/user/wallets?user_ref={USER_REF}

Request Headers

Name	Type	Description
`Authorization`*	String	`Bearer ${api_key}` — your activated merchant API key.
`x-user-ref`*	String	Unique reference identifying the user whose wallets you want to retrieve.
`x-merchant-ref`*	String	Unique reference identifying the merchant account.

Response

`200 OK`

{
  "message": "fetched",
  "data": [
    {
      "wallet_id": "LBWFUSD:FUSD02654536DB644E4BBDAD5E6A1C5D2F21007AJ",
      "currency": "FUSD:FUSD",
      "available_balance": 0,
      "ledger_balance": 0,
      "chain": "FUSD",
      "status": "COMPLETED"
    }
  ]
}

Response Fields

Key	Type	Description
`message`	String	Message describing the result of the request.
`data`	Array	List of wallets associated with the user.
`data[].wallet_id`	String	Unique identifier assigned to the wallet.
`data[].currency`	String	Currency or asset held by the wallet.
`data[].available_balance`	Number	Balance currently available for use in supported wallet operations.
`data[].ledger_balance`	Number	Total balance recorded in the wallet ledger.
`data[].chain`	String	Identifies the blockchain or underlying asset chain associated with the wallet.
`data[].status`	String	Current status of the wallet.

Updated 27 days ago

Did this page help you?