increase-test
GET/lockbox_addresses

List Lockbox Addresses

Lists Lockbox Addresses that can receive mail containing paper checks. Use the cursor and creation-time filters to select a page and narrow the results; each address is not linked directly to an account.

7 parameters
cursorstringoptional
Returns the page of entries after this cursor.
limitintegeroptional
Maximum number of Lockbox Address objects to return. Must be at least 1 and is capped at 100. Defaults to 100 when omitted.
Default:100
created_at.afterstringoptional
Return results after this timestamp, in ISO 8601 format.
created_at.beforestringoptional
Return results before this timestamp, in ISO 8601 format.
created_at.on_or_afterstringoptional
Return results on or after this timestamp, in ISO 8601 format.
created_at.on_or_beforestringoptional
Return results on or before this timestamp, in ISO 8601 format.
idempotency_keystringoptional
Filter by the idempotency key chosen for the object. Must be 1 to 200 characters.

3 status codes
200Returns a page of Lockbox Address objects and a `next_cursor` value for retrieving the next page; `next_cursor` is null when there are no further results.
dataarray<LockboxAddress>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 cannot be processed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

limit must be at least 1 and is capped at 100; it defaults to 100 when omitted. The created_at filters must use ISO 8601 timestamps, and idempotency_key must be 1 to 200 characters.