UPupflow
Bank Accounts

List BankAccounts

List bank accounts with optional filtering.

get/bank_accounts

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger
Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger
Example:100

Maximum number of items to return per page.

Response

Paginated list of bank accounts.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Example response

{
  "page": 1,
  "limit": 50,
  "total": 100,
  "items": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "externalId": "bWwsZWZuem8g",
      "alias": "USA Account",
      "currency": "EUR",
      "source": "USER_DEFINED",
      "swift": "BOFAUS3N",
      "accountNumber": "FR1420041010050500013M02606",
      "routingNumber": "091000019",
      "bankName": "Bank Of America",
      "region": "US",
      "createdAt": "2015-05-05T12:30:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.