GET
/
api
/
bank
/
accounts

Requirements to consume the endpoint.

User approved

The user must be approved in at least one country.

Authorizations

x-api-key
string
header
required

Query Parameters

userId
string

User id by which you want to filter.

brokerId
string

Broker id by which you want to filter.

country
enum<string>

Country by which you want to filter.

Available options:
MX,
PE,
US
fiat
enum<string>

Fiat by which you want to filter.

Available options:
USD,
MXN,
PEN
page
integer

Used to specify the current page you want to get in the paging results.

limit
integer

Used to specify the maximum number of records to be returned on a single page.

Response

200 - application/json
accountHolderName
string

Name of the account holder.

accountNumber
string

Number of the bank account.

approved
boolean

Indicates if the bank account has been approved.

bankName
string

Name of the bank.

CLABE
string

The Standardized Bank Code (CLABE) associated with the bank account, used in Mexico.

country
enum<string>

Country of the bank.

Available options:
MX,
PE,
US
createdAt
string

Creation date and time of the bank account.

fiat
enum<string>

Fiat currency of the bank account.

Available options:
USD,
MXN,
PEN
id
string

Id of the bank account.

notes
string

Notes about the bank account.

swiftCode
string

The SWIFT/BIC code associated with the bank account, used for international wire transfers.

userId
string

Id of the user who owns the bank account.