Skip to navigation
API DocumentationBill payments

Look up a bill account

View as Markdown
Validates a utility reference and returns customer details before payment. Call this when the subcategory has lookupAvailable set to true.

Authentication

x-api-keystring
API Key authentication via header
x-api-secretstring
API Key authentication via header

Request

This endpoint expects an object.
utilitystringRequired
utilityCode from the subcategory.
utility_refstringRequired
Customer account, meter, or control number.

Response

Lookup result
statusstring
codeinteger
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error