v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

List Account Numbers

get/account_numbers

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[]

The status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

ach_debit_status.instring[]

The ACH Debit status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

account_idstring

Filter Account Numbers to those belonging to the specified Account.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

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

Account Number 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_id": "account_in71c4amph0vgo2qllky",
      "account_number": "987654321",
      "created_at": "2020-01-31T23:59:59Z",
      "id": "account_number_v18nkfqm6afpsrvy82b2",
      "idempotency_key": null,
      "inbound_ach": {
        "debit_status": "blocked"
      },
      "inbound_checks": {
        "status": "check_transfers_only"
      },
      "name": "ACH",
      "routing_number": "101050001",
      "status": "active",
      "type": "account_number"
    }
  ],
  "next_cursor": "v57w5d"
}

All 241 operations