Payment - API E-Wallet
Through the E-Wallet payment method, NICEPAY offers you the convenience of cross-app payments (Jump App) for your Customers. Notifications will be sent to customers in real-time as soon as customers complete payments.
- Please visit the E-Wallet Payment Flow page to acknowledge the flow difference between the general E-Wallet with AstraPay.
API Payment E-Wallet aims to activate the E-Wallet payment method at Merchants, so that Customers can make payment transactions using E-Wallet with Merchants. This stage is to integrate the Merchant system with the NICEPAY system.
API URL | /nicepay/direct/v2/payment |
Request Method | POP UP, Redirect, Submit |
Description | Performs Payment Request to NICEPAY |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
Request Format | application/x-www-form-urlencoded |
The payment process can only be carried out after going through the registration process, please learn further about registration on Registration - API E-Wallet page.
The following is a list of parameters for requesting registration of the E-Wallet payment method. This parameter is used through the API testing platform as one of the stages so that the merchant's system can connect with services from NICEPAY.
Additional notes for ShopeePay, to produce a better user experience for Customers, please provide a warning message information to customers to access via mobile devices.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221208065959 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST05202212081111197444 |
merchantToken Required | AN | 255 | Merchant Token | 324a7d07d9f3fe30a3960b28af29a91fc30a33fb3332cf33d40394f30d1f399f |
callBackUrl RequirementResult.jd | AN | 255 | Result Page | https://www.nicepay.co.id/IONPAY_CLIENT/paysp |
returnJsonFormat Required for Shopeepay | AN | 100 | If the value is 1, then it will return Shopeepay link. If the value is empty/0, then it will redirect to other HTML Page | 1: return redirectUrlApp and/or redirectUrlHttp empty/0: return HTML to redirect |
You can follow the integration and testing guidance of Shopee Pay E-Wallet on E-Wallet Integration & Testing page.
After request for E-Wallet payment, the response obtained from E-Wallet payments is in the form of a Callback.
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 14 | Result Code | 0000 |
resultMsg | AN | 225 | Result Message: Error Code | Success |
tXid | AN | 30 | Transaction ID | IONPAYTEST05202406260930529202 |
referenceNo | ANS | 40 | Merchant's Ref. No | 20240626093051 |
payMethod | N | 2 | 05 | |
amt | N | 12 | Amount | 10000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20240626 |
transTm | N | 6 | Transaction Date (HH24MISS) | 093052 |
mitraCd | AN | 4 | Mitra Code | ESHP |
callBackUrl | ANS | 500 | Payment result forward URL (on browser) | https://merchant.co.id/nicepay-callback |
When Your callback already received callbackUrl, NICEPAY recommended the Merchant to do the status verification using the Status Inquiry - API E-Wallet.
CallBack Handling is very important to help minimize fraud. NICEPAY highly recommend the Merchant to do the verification using CallBack Handling
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | Result M essage: Error Code | Success |
tXid | AN | 30 | Transaction ID | IONPAYTEST05202406260930529202 |
referenceNo | ANS | 40 | Merchant's Ref. No | 20240626093051 |
payMethod | N | 2 | 05 | |
amt | N | 12 | Amount | 10000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20240626 |
transTm | N | 6 | Transaction Date (HH24MISS) | 093052 |
mitraCd | AN | 4 | Mitra Code | ESHP |
paymentExpDt | N | 8 | Payment Expiry Date (YYYYMMDD) | 20240626 |
paymentExpTm | N | 6 | Payment Expiry Time (HH24MISS) | 093530 |
redirectUrlHttp | AN | 100 | Returns a universal link redirecting users to E-Wallet payment page. | https://pay.uat.airpay.co.id/h5pay/example |
redirectUrlApp | AN | 100 | Returns a URL redirecting users to the E-Wallet mobile apps. | For ShopeePay, this value will be deprecated |
redirectToken | AN | 2000 | | Used only for LinkAja |