Workflow for merchant
- Present a “Pay with iPay” button at checkout
- When the user selects “Pay with iPay”, merchant should create an order in iPay (using the Create order API). In this request, merchant is required to specify the amount, description, and 3 callback urls (success, failure and cancellation). If everything is fine, merchant will receive a payment Url in the response of that API call.
- Merchant should direct the user’s browser to the paymentUrl received from iPay. From there, the payment will be handled by iPay. iPay might present a login page to authenticate the user. After authentication, the payment page will look similar to the second image on the side.
- The iPay member will select the “Pay” button to confirm the payment, or “Cancel” to cancel the payment. There might be additional steps to finish the payment if the member has multi-factor authentication enabled. All of these will be handled by iPay.
After a payment is successfully completed, iPay’s payment
gateway will redirect the client’s browser to the
success CallbackUrl. This url should be hosted by
merchant’s system, so merchant will know when the
payment is successfully finished. Once the success callback is hit, It is strongly recommended that the merchant also uses the Check order status API from
backend to ensure that the payment is actually successful.