Skip to main content

Bill payment requests

Endpoints for managing and retrieving bill payment requests.

📄Documentation

Get bill payment requests based on filters.

Retrieve a paginated list of bill payment requests based on optional filter criteria. The filters can include biller ID, debt reference, amount range etc. This endpoint is typically used to fetch the user's bill payment history or to search for specific bill requests.

Explorer
📄Documentation

Save a bill payment request. If the field isCart is set to true, it handles the creation of a new cart or adds the bill payment request to an existing cart retrieved by its ID.

This endpoint performs the following actions:

Explorer
📄Documentation

Get bill payment request summary.

Retrieve a summary of a specific bill payment request based on its ID. This endpoint provides an overview of the request details,

Explorer
📄Documentation

BillPaymentRequestAction : sign, abandon or cancel a bill payment request.

Executes an action on a bill payment request based on its ID.

Explorer
📄Documentation

Sign a bill payment request.

Signs the bill payment request identified by the given ID. This is typically the final step before executing the transaction. The signature ensures that all details are confirmed and authorized.

Explorer
📄Documentation

Initialize a payment instance for bill payment.

Prepares and returns all necessary data required to initiate a payment process (e.g., transaction details, archive tasks). This endpoint is used before submitting a payment to load and initialize the UI with the appropriate context.

Explorer
📄Documentation

Send OTP via SMS for a bill payment request.

Sends a One-Time Password (OTP) via SMS for the specified bill payment request.

Explorer
📄Documentation

Get payment receipt for a bill payment request.

Retrieve the payment receipt for a specific bill payment request based on its ID. This endpoint provides the receipt in byte array format, which can be used to generate a PDF or other formats.

Explorer
📄Documentation

Calculate transaction fees for a specific bill payment request.

Calculate the transaction fees for a specific bill payment request. This endpoint is typically used to inform the user about the applicable fees before confirming the payment.

Explorer