Skip to navigation
Sare Core APIWallet

Query Bill

View as Markdown

Looks up what a biller reports as currently due for an account, before paying. Only billers paid through Choice’s bill payment service (CHOICE_BILL payment method, e.g. pay-TV, water) support this; others return 400. dueAmount/dueDate/currency are null when Choice returns them empty, and dueDate is Choice’s string, unparsed. No Idempotency-Key needed - it’s a read.

Headers

AuthorizationstringOptional
X-Device-IdstringOptional

Required on non-GET requests to non-public paths (DeviceSignatureFilter), skipped for GET/whitelisted/multipart requests and in the local profile.

X-SignaturestringOptional

Base64 ECDSA signature over sha256(body) + timestamp + requestId, signed with the device's registered private key.

X-TimestampstringOptional

Unix epoch seconds; must be within 5 minutes of server time.

X-Request-IdstringOptional

Unique per request - reused values are rejected as replays.

Request

This endpoint expects an object.
billProviderIdstringOptional
accountNumberstringOptionalformat: "utc-millisec"

Response

200 OK
codeintegerOptional
messagestringOptional
dataobjectOptional

Errors

400
Bad Request Error