v4

OpenAPI 3.1.02026-08-012402353.8 MB

List External Accounts

get/external_accounts

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.instring[]

Filter External Accounts for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

routing_numberstring

Filter External Accounts to those with the specified Routing Number.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

External Account List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "account_holder": "business",
      "account_number": "987654321",
      "created_at": "2020-01-31T23:59:59Z",
      "description": "Landlord",
      "funding": "checking",
      "id": "external_account_ukk55lr923a3ac0pp7iv",
      "idempotency_key": null,
      "routing_number": "101050001",
      "status": "active",
      "type": "external_account"
    }
  ],
  "next_cursor": "v57w5d"
}