Skip to navigation

Verify Entity (Meter / Smartcard)

View as Markdown

Validates a meter number (Utility) or smartcard number (Cable TV) and returns a meterVerificationId — required by Purchase Utility Bill and Purchase Cable TV, and single-use.

Body (JSON):

FieldTypeRules
serviceCategoryIdstringrequired, 4–250 chars; must be an active Utility or Cable TV category
entityNumberstringrequired, max 250; meter number (Utility) or smartcard/IUC number (Cable TV)

Returns a single-use meterVerificationId plus the customer name on the account. type is UTILITY or CABLE_TV. For Utility, the meter’s vend type (PREPAID/POSTPAID) is stored from the provider and Purchase Utility Bill must send the same vendType. A verification is consumed by a purchase and released again only if that purchase is refunded. Provider lookup failures return 500.

Error format: body validation failures (Joi) return { "status": "error", "message": "Validation error", "details": [ ... ] }; all other errors return { "success": false, "message": "..." }. Money fields (amount, fee) are Prisma Decimals and are serialized as strings (e.g. "1000").

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Request

This endpoint expects an object.
serviceCategoryIdstringOptional
entityNumberstringOptional

Response

Success (Utility meter) / Success (Cable TV smartcard)

successbooleanOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error