E-Wallet - API Checkout
This API uses by Merchants to request a payment to the NICEPAY for the E-Wallet payment method using Checkout API.
![General E-Wallet Flow General E-Wallet Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/swtXOkrjk3igquNnLbEZx_nicepay-archbee-payment-e-wallet-join.png?format=webp)
Flow description after checkout the order:
- The Customer requests checkout to the Merchant.
- The Merchant sends the checkout request using Registration API to NICEPAY.
- NICEPAY sends the response of order regist to the Merchant.
- The Merchant sends the Payment API to NICEPAY.
- NICEPAY requests payment to the E-Wallet Partner.
- The E-Wallet Partner generates the order.
- NICEPAY stores the payment information.
- During payments:
- If the Customer is using OVO E-Wallet, then the e-Wallet Partner will send notification to the related application to makes a payment.
- If the Customer is using another E-Wallet (excluding OVO and AstraPay), then the E-Wallet Partner will redirects Customer to the Partner's payment page. After that, the Customer must login using their related E-Wallet account before proceeding the payment process.
- The Customer sends the payment to the E-Wallet Partner.
- The E-Wallet Partner receives the payment.
- The E-Wallet Partner sends a notification to NICEPAY.
- NICEPAY receives the notification.
- NICEPAY sends the notification to the Merchant.
- The Merchant receives the notification.
- The Merchant requests a status check to NICEPAY.
- NICEPAY sends the response of status checking to the Merchant.
- The Merchant receives the final status.
- The Merchant sends an order confirmation to the Customer.
![AstraPay E-Wallet Flow AstraPay E-Wallet Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/bNnVV1xwxsDP2QIBNxw9s_nicepay-archbee-payment-e-wallet-astrapay.png?format=webp)
Flow description during payments:
- If the Customer doesn't have AstraPay account yet.
- The Customer requests checkout to the Merchant.
- NICEPAY sends the account link request to AstraPay.
- AstraPay receives the request sent by NICEPAY.
- AstraPay sends the response of redirect URL to the Partner's page to NICEPAY.
- NICEPAY sends the response of the Partner's redirect URL to the Merchant.
- The Merchant displays registration page to the Customer.
- The Customer proceeds with the account registration.
- The Customer sends the account registration to AstraPay.
- AstraPay validates the account.
- AstraPay sends a notification to NICEPAY.
- NICEPAY sends a notification to the Merchant.
- The Merchant sends a notification that the account already registered to the Customer.
- The Customer requests checkout to the Merchant.
- NICEPAY requests the transaction to AstraPay.
- AstraPay generates the transaction.
- AstraPay sends the response of redirect URL to NICEPAY.
- NICEPAY sends the response of payment page redirect URL to Merchant.
- The Merchant redirects the Customer to AstraPay's payment page.
- The Customer verifies the payment.
- The Customer makes payment to AstraPay.
- AstraPay performs payment verification.
- AstraPay sends a callback to NICEPAY.
- NICEPAY sends the response to the Merchant.
- Merchant displays the response of callback to the Customer.
- AstraPay sends a notification to NICEPAY.
- NICEPAY receives the notification.
- NICEPAY sends notification to the Merchant.
- The Merchant receives the notification.
- The Merchant requests a payment status check to NICEPAY.
- NICEPAY sends the response to the Merchant.
- The Merchant receives the final status.
- The Merchant updates transaction status to the Customer.
The checkout process has two different flows, namely asynchronous and synchronous. In the asynchronous process flow, Customers need input credentials to enter the Partner's application before making payments. Meanwhile, for a synchronous process, Customers don't need to input the application's credentials first and can immediately make payments via payment notifications sent to the Customer's application.
The difference in these flows can be seen from the two E-Wallet process flows below.
![Asynchronous on the E-Wallet Process Flow Asynchronous on the E-Wallet Process Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/Ro3IEekft89HgP9w5IyB-_nicepay-archbee-payment-e-wallet.png?format=webp)
Flow description after checkout of the order:
- The Customer requests checkout to the Merchant.
- The Merchant sends a checkout request by using Registration API to NICEPAY.
- NICEPAY sends the response of Registration API to the Merchant.
- The Merchant requests Payment API to NICEPAY.
- NICEPAY requests payment to the E-Wallet Partner.
- The E-Wallet Partner generates the order.
- NICEPAY stores the payment information.
- If the Customer uses another E-Wallet (excluding OVO and AstraPay), then the E-Wallet Partner will redirect the Customer to the Partner's payment page.
- The Customer login to the related E-Wallet account before making payment.
- The Customer sends the payment to the E-Wallet Partner.
- The E-Wallet Partner receives the payment.
- The E-Wallet Partner sends a notification to NICEPAY.
- NICEPAY receives the notification.
- NICEPAY sends a notification to the Merchant.
- The Merchant receives the notification.
- The Merchant requests status checking to NICEPAY.
- NICEPAY sends a response of status checking to the Merchant.
- The Merchant receives the final status.
- The Merchant sends an order confirmation to the Customer.
![Synchronous on the E-Wallet Process Flow Synchronous on the E-Wallet Process Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/n7SzPqy6DiTnzKxGH89bM_nicepay-archbee-payment-ewallet-ovo.png?format=webp)
Flow description after checkout of the order:
- The Customer requests checkout to the Merchant.
- The Merchant sends a checkout using Registration API to NICEPAY.
- NICEPAY sends a response of order regist to the Merchant.
- The Merchant sends Payment API to NICEPAY.
- NICEPAY requests payment to the E-Wallet Partner.
- The E-Wallet Partner generates the order.
- NICEPAY stores the payment information.
- The E-Wallet Partner (OVO) will send a notification to the related application to make payments.
- The Customer sends payment to the E-Wallet Partner.
- The E-Wallet Partner receives payment.
- The E-Wallet Partner sends a notification to NICEPAY.
- NICEPAY receives the notification.
- NICEPAY sends notifications to the Merchant.
- The Merchant receives the notification.
- The Merchant requests status checking to NICEPAY.
- NICEPAY sends a response from status checking to the Merchant.
- The Merchant receives the final status.
- The Merchant sends an order confirmation to the Customer.
![Secure Payment Page Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/3NkVq_tnR2CAVmV5qDDqg_eng-new-secure-payment-page-gpn.png?format=webp)
The image above is a Checkout payment sample with an E-Wallet method using NICEPAY Secure Payment Page.
![E-Wallet - Secure Payment Page E-Wallet - Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/D7mEWVEf7WK1nc6Cj7udU_eng-new-secure-payment-page-e-wallet.png?format=webp)
After the process of the payment registration request completes, you can continue the transaction process until settlement by following the guidelines in the E-Wallet Payment Guide.
Note for ShopeePay and OVO E-Wallet, to provide a better user experience to the Customer, please give a warning message for the Customer to open via mobile devices.
![Success - Secure Payment Page Success - Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/GtD5DLBhVSbJyovBW0SD8_eng-new-secure-payment-page-e-wallet-1.png?format=webp)
API URL | /nicepay/redirect/v2/payment |
Request Method | Redirect-GET |
Header | Content-Type: application/Form-UrlEncoded |
Parameter | Type | Size | Description | Remark |
paymentURL Required | ANS | 14 | Payment URL | https://dev.nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | TNICEEW05100202212201020014087 |
Note for ShopeePay and OVO E-Wallet, to better user experience to the Customer, please request give a warning message for the Customer to open by mobile devices.
Parameter | Type | Size | Description | Remark |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202212201351474222 When Success |
referenceNo | ANS | 40 | Order Number | ordNo20221220131215 When Success |
payMethod E-Wallet, Payloan | N | 2 | 05 When Success | |
amt | N | 12 | Transaction Amount | 5000 When Success |
transDt Only CC (Additional) | N | 8 | Transaction Date (YYYYMMDD) | 20221220 When Success |
transTm CC | N | 6 | Transaction Time (HH24MISS) | 135201 When Success |
mitraCd Direct Debit, E-Wallet, Payloan | A | 4 | DANA When Success | |
callBackUrl | ANS | 255 | Payment Result URL | https://webhook.site/7bef799f-ebe2-4328-a7b3-6d53deedca27 When Success |
Note: Response parameter will be sent through callbackUrl with Content-type: application/json and method: POST Parameter.
On the payment in Checkout, the response from the request that gets hit is the callback URL.
When Your callback already received callbackUrl, we recommended the Merchant to do the status verification using the Status Inquiry - API Checkout.
CallBack Handling is very important to minimize the Fraud act, we highly recommend the Merchant to do the verification using callBack parameter.
![Callback Handling Flow Callback Handling Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/Z__-k6f4KP90_b0GZZhYa_nicepay-api-checkout-api-callback-handling-flow-1.png?format=webp)