Accounts
Get Accounts by User
Lists the bank accounts that belong to a single user.
Request
| Field | Type | Required | Description |
|---|---|---|---|
| Authorization | Header | Yes | Bearer <access_token> obtained from POST /api/v1/client/token. |
| user_id | Path | Yes | Identifier of the user, from GET /admin/users. |
| page | Query | No | Page number, starting at 1. |
| pageSize | Query | No | Number of records per page. |
Response
Paginated responses share the same envelope: items (the records), total, page, pageSize, orderBy and orderDirection. Each item contains:
| Field | Description |
|---|---|
| id | Unique identifier of the bank account. Use it as destination in withdrawals and payouts. |
| status | Review status. The account can only be used when it is APPROVED. |
| name | Alias set when the account was registered. |
| number | Account number (or Bre-B key for BREB accounts). |
| type | SAVING or CHECKING. |
| currency | Currency of the account. |
| bankName | Banking entity. |
| registerDate | Date the account was registered. |
| userId | Owner of the account: your own user or one of your end users. |
| accountMetadata | Additional regional details (e.g. ABA, CLABE). |
GET
Get Accounts by User