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

Attributes

Field	Type	Description
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
description	string	Human-readable description of the biller
logo_url	string	URL to the biller logo image
website_url	string	Biller website URL

Example Biller object

JSON

{
  "id": "test_electric_company",
  "name": "Test Electric Company",
  "type": "UTILITY",
  "status": "ACTIVE",
  "credentials_required": true,
  "mfa_required": false,
  "description": "Simulated electric utility biller"
}

GET/billers

List billers with optional filtering and pagination.

Query Parameters

Field	Type	Description
search_term	string	Filter billers by name
status	string	Filter by status: ACTIVE, INACTIVE
type	string	Filter by type: UTILITY, FINANCIAL, etc.
page	integer	Page number (default: 1)
page_size	integer	Results per page (default: 10, max: 100)

Response

{
  "billers": [Biller],
  "total": 5,
  "page": 1,
  "page_size": 10
}

curl https://sandbox.api.billerapi.com/billers \
  -H "X-Client-ID: your_client_id" \
  -H "X-Client-Secret: your_client_secret"

GET/billers/:id

Retrieve a specific biller by ID.

Path Parameters

Field	Type	Description
id*	string	The biller ID

curl https://sandbox.api.billerapi.com/billers/test_electric_company \
  -H "X-Client-ID: your_client_id" \
  -H "X-Client-Secret: your_client_secret"

GET/billers/search/by-email

Search for billers associated with an email address. Useful for discovering which billers a user might have based on their email domain.

Query Parameters

Field	Type	Description
email*	string	Email address to search for biller matches

curl "https://sandbox.api.billerapi.com/billers/search/by-email?email=user@example.com" \
  -H "X-Client-ID: your_client_id" \
  -H "X-Client-Secret: your_client_secret"