List Bank Accounts
Get every bank account on file for one of your users, in a single list.
This combines two kinds of bank account into one response:
- Linked bank accounts — bank accounts the user connected from an
outside bank (for example a standard bank account, or an ACH, RTP, or
wire account, or an account that was linked instantly). These have a
typeoflinked_bank_account. - Virtual bank accounts — bank accounts Finogate issued to the user so
they have their own account number and routing number for receiving
money. These have a
typeofvirtual_bank_account.
The type field on each item tells you which kind it is. Fields that
only apply to one kind are filled in for that kind and left empty
(null) for the other.
For safety, linked bank account details are always masked — you only ever see a masked account number and the last 4 digits of the routing number.
The list is ordered newest first, and is split into pages using limit
and offset.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique ID of the user whose bank accounts you want.
"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"
Query Parameters
How many bank accounts to return per page (1 to 200).
1 <= x <= 200How many bank accounts to skip before this page starts.
x >= 0Response
Successful Response
Standard response wrapper for list responses.
Declare ListResponse[list[SomeModel]] to render the real data
array schema in OpenAPI/Swagger; a bare ListResponse leaves data
untyped.
HTTP status code for the response.
Payload or error details.
UTC timestamp (milliseconds since epoch) when response was generated.
Total rows matching the request filters (not just this page).
x >= 0Page size used for this response. Null for cursor-paginated endpoints.
x >= 11-indexed page number for this response. Null for cursor-paginated endpoints.
x >= 1Total number of pages given the current limit. Null for cursor-paginated endpoints.
x >= 0Cursor for the next page, if available.