Navigation

Environments

BillerAPI provides separate sandbox and production environments so you can develop and test without affecting real data.

Sandbox vs Production

Every BillerAPI account has access to both environments. Sandbox uses test data and test billers — no real credentials are ever processed. Production connects to real biller sites and returns real bill data.

SandboxProduction
Base URLhttps://sandbox.api.billerapi.comhttps://api.billerapi.com
API key prefixbb_test_bb_live_
Billers5 test billers (see below)Real biller integrations
DataSynthetic test data, deterministic responsesReal bills and account data
Rate limitsSame as production100 req/min (most endpoints)
WebhooksSandbox events onlyReal-time events

There is also a staging environment at https://api.staging.billerapi.com used for internal testing. This is not available to external developers.

Switching Environments

To move from sandbox to production, change two things: the base URL and the API keys. All endpoint paths, request bodies, and response shapes stay the same.

Environment configuration
// Sandbox
const BASE_URL = 'https://sandbox.api.billerapi.com';
const CLIENT_SECRET = 'bb_test_xxxxxxxx';

// Production — just swap these two values
const BASE_URL = 'https://api.billerapi.com';
const CLIENT_SECRET = 'bb_live_xxxxxxxx';

Sandbox Test Billers

The sandbox environment includes five test billers that simulate different biller types. These are always available and return deterministic test data.

Biller IDNameType
test_electric_companyTest Electric CompanyUtility
test_credit_cardTest Credit CardFinancial
test_internet_providerTest Internet ProviderTelecom
test_insurance_companyTest Insurance Co.Insurance
test_water_utilityTest Water UtilityUtility

Use account number 4242424242 with any username and password to simulate a successful account link. See the Getting Started guide for the full list of test account numbers and scenarios.

Related