BVbvnk
Fiat Payments

Get wallets

Changed on

Shows all Direct and Customer wallet types. Results are summaries only (payment instruments are not included); use GET /ledger/v2/wallets/{id} to retrieve a single wallet with full details including payment instruments.

The endpoint uses the Lucene query syntax, for example, GET https://api.bvnk.com/ledger/v2/wallets?q=customerId:550e8400-e29b-41d4-a716-446655440000 AND status:(ACTIVE OR INACTIVE) returns all active and inactive wallets for that customer.

Note: Field names in the q search expression are case-sensitive. If you use a field that is not recognised, it is ignored.

Operator OR is only supported within the same field (group alternatives with parentheses), not across different fields.

  • Supported: ?q=currency:(USD OR EUR)
  • Not supported: ?q=currency:USD OR customerId:550e8400-e29b-41d4-a716-446655440000
get/ledger/v2/wallets

Request

Query parameters

qstring
Example:customerId:550e8400-e29b-41d4-a716-446655440000 AND status:(ACTIVE OR INACTIVE)

Search and filter expression in the Lucene syntax. Use q with AND / OR to combine filters. You can specify only one currency or customerId value, but several status and currencyType values.

  • customerId: Filter by customer ID. Values must be valid UUIDs.
  • status: Filter by the wallet status. Values must be ACTIVE, INACTIVE, or TERMINATED.
  • currencyType: Filter by the wallet's currency type. Values must be FIAT or CRYPTO.
  • currency: Filter by currency codes. Allowed values: USD, EUR, GBP, USDT, POL, PYUSD, BTC, SOL, BNB, XRP, ETH, LTC, USDC, USDG, TRX, EURC, DOGE.
pageNumberinteger

Page number for pagination. Starts from 0.

pageSizeinteger

Number of items to return per page.

Response

OK

hasNextboolean

Flag that shows whether another page of results exists.

Example response

{
  "content": [
    {
      "id": "a:25041855293741:pWnL4vB:1",
      "name": "USD Operations",
      "status": "ACTIVE",
      "balance": {
        "amount": 1000,
        "currency": "USD"
      },
      "createdAt": "2025-02-13T22:55:56.104Z",
      "updatedAt": "2024-12-18T14:12:11.743Z"
    }
  ],
  "pageable": {
    "pageSize": 10
  }
}

Changes