Skip to main content

Get wallets

GET 

/ledger/v2/wallets

Beta

This endpoint is currently in beta. The API contract may change during this phase. We recommend testing thoroughly in sandbox before using it in production.

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

Request

Responses

OK

Was this page helpful?