This section describes the Bill Payment APIs and the necessary steps involved: Bill Initiation, Bill Payment by the user, and Bill Verification.Bill initiation#
This step is performed within the merchant application. The user will be presented with a form to enter their email, phone number, or iHelá ID. The application will then submit this information along with all payment details to create a bill in the user’s iHelá account. The user will automatically see the bill across all iHelá client applications and can pay it before it expires.Bills can be created in a partner bank based on the list of supported banks provided in our APIs. In this case, the merchant application must send the bank slug during bill initiation. If no bank slug is provided, the bill is created directly within iHelá.By default, bills created in iHelá expire within 1 week. However, this expiration time can vary depending on the merchant or the bank associated with the bill. For example, bills sent to mobile banks may expire within 5 to 10 minutes, as mobile bank bills typically have shorter expiration times.Bill payment#
After initiation, the user can view unpaid bills in our applications such as the mobile app or web and proceed to pay them. If a redirect URL is specified in the bill, the user will be redirected back to the merchant application upon payment completion.Bill verification#
Direct verification#
The merchant application can verify the bill status by calling the Bill Validation endpoint. The bill status can be one of the following: "Paid," "Error," "Pending," or "Expired." This verification can be scheduled as a cron job or performed on-demand, such as when viewing payment details in the merchant application.Callback configuration#
Alternatively, the merchant application can configure a callback endpoint to receive payment confirmation notifications after the user completes the payment. The merchant must provide a URL for this callback following the specified guidelines. Modified at 2025-05-30 09:38:21
