Billers
Search and retrieve billers in the BillerAPI network. Use these endpoints to discover available billers, search by email domain, or retrieve details for a specific biller.
Related guide: Link a Biller Account
The Biller object
A Biller is a company in the BillerAPI network that a user can link to retrieve statements — a utility, lender, telecom, or government agency. Discover billers, then use the biller ID to start a link session.
Attributes
| id*string | Unique biller identifier |
| name*string | Display name of the biller |
| type*string | Biller category: UTILITY, FINANCIAL, GOVERNMENT, TELECOM, INSURANCE |
| status*string | ACTIVE, INACTIVE, or MAINTENANCE |
| credentials_required*boolean | Whether the biller requires user credentials to link |
| mfa_required*boolean | Whether multi-factor authentication is needed |
| descriptionstring | Human-readable description of the biller |
| logo_urlstring | URL to the biller logo image |
| website_urlstring | Biller website URL |
The Biller object
{
"id": "test_electric_company",
"name": "Test Electric Company",
"type": "UTILITY",
"status": "ACTIVE",
"credentials_required": true,
"mfa_required": false,
"description": "Simulated electric utility biller"
}GET
/v1/billersList billers with optional filtering and pagination.
Query parameters
| search_termstring | Filter billers by name |
| statusstring | Filter by status: ACTIVE, INACTIVE |
| typestring | Filter by type: UTILITY, FINANCIAL, etc. |
| pageinteger | Page number (default: 1) |
| page_sizeinteger | Results per page (default: 10, max: 100) |
Sample uses your_client_id · sign in to auto-fill your sandbox key
curl https://sandbox.api.billerapi.com/v1/billers \
-H "Authorization: Bearer $BILLERAPI_API_KEY"Response
{
"billers": [Biller],
"total": 5,
"page": 1,
"page_size": 10
}GET
/billers/{id}Retrieve a specific biller by ID.
Path parameters
| id*string | The biller ID |
Sample uses your_client_id · sign in to auto-fill your sandbox key
curl https://sandbox.api.billerapi.com/billers/test_electric_company \
-H "Authorization: Bearer $BILLERAPI_API_KEY"GET
/billers/search/by-emailSearch for billers associated with an email address. Useful for discovering which billers a user might have based on their email domain.
Query parameters
| email*string | Email address to search for biller matches |
Sample uses your_client_id · sign in to auto-fill your sandbox key
curl "https://sandbox.api.billerapi.com/billers/search/by-email?email=user@example.com" \
-H "Authorization: Bearer $BILLERAPI_API_KEY"Was this page helpful?