Utility Payments
Utility Payments
The UTILITY transaction request type pays a bill or buys a prepaid service, for example a prepaid electricity meter token. The biller is identified by a routing scheme of the category UTILITY or BILL, such as a meter number or a bill control number.
- Look the payee up first, to confirm who will be paid (Confirmation of Payee). The lookup returns a
lookup_id. - Create the transaction request, passing the
lookup_idasverified_payee_lookup_id, and optionally acallback_url. - The result, such as the electricity token, does not exist yet when the request is created. It arrives later from the payment rail and is recorded as the vend result. The registered callback is then called once.
data_fields carries name and value pairs that adapters pass on to the payment rail unchanged.
Endpoints
- Create Payee Lookup:
POST /obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/payees/lookup - Create Transaction Request (UTILITY):
POST /obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/UTILITY/transaction-requests - Create Utility Vend Result:
POST /obp/v7.0.0/banks/BANK_ID/utility-payments/UTILITY_TRANSACTION_REQUEST_ID/vend-result