List Payer Accounts
List the payer accounts your credentials can access — the platform-level (Tier 2) read backing the cross-account view and account switcher; scoped credentials return only the ones they cover. Payer accounts are provisioned when a platform onboards a business — there is no customer-facing create endpoint.
Request
- Base URLhttps://api.justifi.ai/v1
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
token to fetch the next page of a list (the end_cursor from a previous response's page_info)
token to fetch the previous page of a list (the start_cursor from a previous response's page_info)
the number of resources to retrieve per page (default 25, max 100)
filter payer accounts by status
filter to the payer accounts belonging to a single business. Use this to resolve a business's payer account(s) from the biz_… id you already hold — a business holds one payer account, so it returns a single record.
filter payer accounts to those whose name contains this value, case-insensitively. Partial matches count, so northside matches "Northside Physical Therapy" — this backs the type-ahead in the account switcher rather than an exact-name lookup.
filter to a single payer account by its payer_… id. Matches exactly; an id that is not a payer_… id is rejected with 400.
Headers
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)
Response
Successfully listed payer accounts
Example response
{
"type": "array",
"data": [
{
"id": "payer_123xyz",
"type": "payer_account",
"business_id": "biz_123xyz",
"name": "Northside Physical Therapy",
"mode": "live",
"status": "active",
"provisioned_at": "2026-01-01T12:00:00Z",
"funding_bank_account_id": "ba_fund456",
"created_at": "2026-01-01T12:00:00Z",
"updated_at": "2026-01-01T12:00:00Z"
}
],
"page_info": {
"start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd",
"end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.