Skip to main content
GET
List Accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-partner-id
string
default:""
required

The Partner ID header used for authorization

Query Parameters

account_titles
string

Filter based on account titles

Example:

"Safepay Inc."

routing_numbers
string

Filter based on routing numbers

Example:

"011000015"

status
enum<string>

Filter for accounts with a specific status

Available options:
AS_Verified,
AS_Unverified,
AS_Deleted
Example:

"AS_Verified"

limit
string

Set the limit for search results

Example:

"3"

page
string

Set the page offset

Example:

"1"

Response

Response when retrieving a list of accounts

Standard response structure for successful operations

ok
boolean

Indicates if the operation was successful

Example:

true

data
object

Contains the response data