Find bank accounts by criteria

Searches for bank accounts based on specified criteria such as account type, currency, or other filters.

Path parameters

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

namestringOptional
Filter by bank account name
entitystringOptional
Filter by bank entity name
kindenumOptional

Filter by bank account kind (e.g., BANK, CRYPTO)

Allowed values:
isVirtualstringOptional

Filter by whether the account is virtual (true/false)

addressstringOptional

Filter by crypto address (if applicable)

networkstringOptional

Filter by crypto network (if applicable)

typeenumOptional
Filter by bank account type
Allowed values:
accountNumberstringOptional
Filter by account number
routingNumberstringOptional
Filter by routing number
countryIdstringOptional

Filter by country ID (UUID)

currencyIdstringOptional

Filter by currency ID (UUID)

contactIdstringOptional

Filter by associated contact ID (UUID)

countrySymbolenumOptional

Filter by country code (e.g., US, AR)

currencySymbolstringOptional

Filter by currency code (e.g., USD, ARS)

isDefaultstringOptional

Filter by whether the account is the default account (true/false)

isTrackedstringOptional

Filter by whether the account balance is tracked (true/false)

isDeletedstringOptional

Filter by deletion status (true/false). If omitted, defaults to active accounts

isFiatstringOptional

Filter by account type: true for fiat accounts (BANK), false for crypto accounts (CRYPTO)

Response

Find bank accounts by criteria for a merchant
idstring
namestring
entitystring
kindenum
Allowed values:
isVirtualboolean
addressstring
networkstring
typeenum
Allowed values:
accountNumberstring
routingNumberstring
countryIdstring
currencyIdstring
currencyCodestring
Currency symbol
createdAtdatetime
updatedAtdatetime
isDefaultboolean
isTrackedboolean
merchantIdstring
contactIdstring
countryCodestring or null

Two-letter ISO country code

Errors