increase-test
GET/account_numbers

List Account Numbers

Lists Account Numbers, with optional filters for status, account, and creation time. Use cursor and limit to paginate the results; limit defaults to 100 and cannot exceed 100.

10 parameters
cursorstringoptional
Cursor identifying the position after which to return the next page of entries.
limitintegeroptional
Maximum number of Account Numbers to return. Must be at least 1 and defaults to 100 when omitted.
Default:100
status.inarray<string>optional
Filter by Account Number status: active, disabled, or canceled. For GET requests, encode multiple values as a comma-delimited string.
ach_debit_status.inarray<string>optional
Filter by ACH debit status: allowed or blocked. For GET requests, encode multiple values as a comma-delimited string.
account_idstringoptional
Filter Account Numbers to those belonging to the specified Account.
created_at.afterstringoptional
Return results after this ISO 8601 timestamp.
created_at.beforestringoptional
Return results before this ISO 8601 timestamp.
created_at.on_or_afterstringoptional
Return results on or after this ISO 8601 timestamp.
created_at.on_or_beforestringoptional
Return results on or before this ISO 8601 timestamp.
idempotency_keystringoptional
Filter by the idempotency key associated with an Account Number. Must be 1 to 200 characters.

3 status codes
200Returns a paginated list of Account Number objects and a `next_cursor` for retrieving the next page.
dataarray<AccountNumber>required
The contents of the list.
next_cursorstringrequired
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`.
4XXReturned when the request encounters a client error.
5XXReturned when the service encounters a server error.

Error handling

limit must be at least 1 and no more than 100. Status filters must use the listed values, and created_at filters must be ISO 8601 timestamps; idempotency_key must be 1 to 200 characters.