Skip to content

Step 4: Bill Presentment (Beta)

Before processing a payment, use the Bill Presentment API to retrieve and display outstanding bill information for the user's account. This enables your application to show current bill details, send bill reminders, and automate recurring payments.

API Reference

For the full endpoint specification (headers, parameters, response schema, and examples), see Bill Presentment API Reference.

Integration Guidelines

Integrate this API across all products. This prevents the need to reintegrate when a new biller is added later.

Your application should dynamically populate the bill information based on the API response. If a particular piece of information — such as customer name — is not returned by the API for a biller, that label or field should not be displayed to the user.

Bill presentment flow showing account entry and bill details from API

Error Handling

API Response (data.message)Application ActionCan User Proceed to Payment?
Account no is validDisplay relevant bill information. Only show fields that are returned.Yes
Bill presentment is unavailable for this productDo not display any bill information.Yes
Service unavailable. Please try again laterDo not display any bill information.Yes
Invalid account noShow error_message to the user (see below).No
Any other errorDo not display any bill information.Yes

Possible error_message values:

  • The provided biller code is invalid
  • The provided amount is invalid
  • Invalid account no
  • Ref-2 is required

IIMMPACT API Documentation