BVbvnk
Fiat Payments

Get wallet profiles

Changed on

Returns available wallet profiles based on optional filters for currency codes and payment methods. For more information on how to apply it in the Embedded Wallets flow, refer to the Retrieve wallet profiles guide.

The endpoint uses the Lucene query syntax, for example, GET https://api.bvnk.com/ledger/v2/wallets/profiles?q=customerId:550e8400-e29b-41d4-a716-446655440000 AND currency:USD returns USD wallet profiles 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/profiles

Request

Query parameters

qstring
Example:customerId:550e8400-e29b-41d4-a716-446655440000 AND currency:USD

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.

  • currency: Filter by currency codes. Allowed values: USD, EUR, GBP, USDT, POL, PYUSD, BTC, SOL, BNB, XRP, ETH, LTC, USDC, USDG, TRX, EURC, DOGE.
  • method: Filter by payment methods. Allowed values: ACH, ACH_SAME_DAY, FEDWIRE, SWIFT, FASTER_PAYMENT, CHAPS, SEPA_CT, SEPA_INST, RTP, BOOK, FEDNOW.
  • customerId: Filter by customer ID. Values must be valid UUIDs. If provided, only profiles that are available for the customer's account will be returned.
pageNumberinteger

Page number for pagination. Starts from 0.

pageSizeinteger

Number of items to return per page.

Response

List of wallet profiles matching the query

totalElementsinteger required

Total number of wallet profiles matching the query.

totalPagesinteger required

Total number of pages available.

hasNextboolean required

Whether there is a next page of results.

Example response

{
  "totalElements": 6,
  "totalPages": 1,
  "content": [
    {
      "id": "fiat:gbp:abcd1234"
    }
  ],
  "pageable": {
    "pageSize": 50
  }
}

Changes