Skip to main content
Retrieve multi-currency wallets (USD & NGN) for an end user account. This endpoint allows you to fetch wallet information including balances, permissions, and settings for a specific entity.

Overview

The Get End User Wallets endpoint returns all wallets associated with a specific entity ID and wallet type. Each wallet contains information about the currency, balance, permissions, and configuration settings.

Parameters

FieldTypeDescriptionRequired
entityIdstringThe unique identifier for the end user accountRequired
walletTypestringThe type of wallet to retrieve (SPEND, COLLECTION)Required

Wallet Types

  • SPEND: Wallets used for spending and transactions
  • COLLECTION: Wallets used for collecting payments and funds

Response Structure

The response includes an array of wallets, each containing:
  • Basic Info: ID, slug, description, currency, balance
  • Permissions: Permission type and flow type
  • Settings: Wallet type, approval threshold, display currency, funding/withdrawal currencies, balance visibility

Example Request

curl -X GET "{{LIQUIDITY_URL}}/v1/ext/wallet/multi-currency/1234567890/spend" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Example Response

{
  "wallets": [
    {
      "id": "79f4e636-9531-4eea-a32d-3792fd63af41",
      "slug": "NGN Wallet",
      "description": "NGN Wallet",
      "currency": "NGN",
      "balance": "0",
      "permissions": {
        "permissionType": "OWNER",
        "permissionFlowType": "ALL"
      },
      "settings": {
        "walletType": "USER",
        "approvalThreshold": 1,
        "displayCurrency": "NGN",
        "fundingCurrencies": ["USD", "NGN"],
        "withdrawalCurrencies": ["USD", "NGN"],
        "showBalance": true
      }
    },
    {
      "id": "feb80df3-060c-4cf5-9b8e-91ae67fb5208",
      "slug": "USD Wallet",
      "description": "USD Wallet",
      "currency": "USD",
      "balance": "0",
      "permissions": {
        "permissionType": "OWNER",
        "permissionFlowType": "ALL"
      },
      "settings": {
        "walletType": "USER",
        "approvalThreshold": 1,
        "displayCurrency": "USD",
        "fundingCurrencies": ["USD", "NGN"],
        "withdrawalCurrencies": ["USD", "NGN"],
        "showBalance": true
      }
    }
  ]
}

Use Cases

  • Balance Checking: Retrieve current wallet balances for display
  • Transaction Preparation: Get wallet details before processing payments
  • Account Management: Display wallet information in user dashboards
  • Integration Setup: Fetch wallet configurations for third-party integrations
  • Audit & Reporting: Generate reports on wallet status and balances