BillerAPI/Docs
Sign inGet started
Accounts

Accounts

Retrieve connected biller accounts for your client. Accounts are created when a user successfully completes a link session.

Related guide: Link a Biller Account

The Account object

An Account is a connected biller relationship. Accounts are created when a user successfully completes a link session, and each one ties a biller to your internal user identifier.

Attributes

id*stringUnique account identifier
biller_id*stringThe biller this account is linked to
biller_name*stringDisplay name of the biller
client_user_id*stringYour internal user identifier
status*stringAccount status: ACTIVE, INACTIVE, ERROR, DISCONNECTED
account_numberstringMasked account number (e.g., ****1234)
last_synced_atstringISO 8601 timestamp of the last successful sync
created_atstringISO 8601 timestamp when the account was linked
updated_atstringISO 8601 timestamp of last update
The Account object
{
  "id": "acc_abc123",
  "biller_id": "test_electric_company",
  "biller_name": "Test Electric Company",
  "client_user_id": "user_456",
  "status": "ACTIVE",
  "account_number": "****1234",
  "last_synced_at": "2026-04-01T12:00:00Z",
  "created_at": "2026-03-15T09:30:00Z",
  "updated_at": "2026-04-01T12:00:00Z"
}
GET/bills/accounts

Get all connected biller accounts for your client. Returns a list of accounts that have been successfully linked through the BillerAPI link flow.

Sample uses your_client_id · sign in to auto-fill your sandbox key
curl https://sandbox.api.billerapi.com/bills/accounts \
  -H "Authorization: Bearer $BILLERAPI_API_KEY"
Response
{
  "accounts": [Account]
}
Was this page helpful?