Payment - API E-Wallet
Through , offers you convenience of cross-app s (Jump App) for your s. Notifications will be sent to s in real-time as soon as s complete s.
aims to activate at s, so that can make s using with s. This stage is to integrate with .
API URL | /nicepay/direct/v2/payment |
|---|---|
Request Method | POP UP, Redirect, Submit |
Description | Performs Request to |
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 s for requesting registration of . This is used through platform as one of stages so that 's can connect with s from .
Additional notes for ShopeePay, to produce a better user experience for s, please provide a warning message to s 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 | Token | 324a7d07d9f3fe30a3960b28af29a91fc30a33fb3332cf33d40394f30d1f399f |
callBackUrl RequirementResult.jd | AN | 255 | Result Page | https://www.nicepay.co.id/IONPAY_CLIENT/paysp |
returnJsonFormat Required for Shopeepay | AN | 100 | If value is 1, then it will return ShopeePay link. If 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 and guidance of ShopeePay on E-Wallet Integration & Testing .
After request for , response obtained from s is in 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 | 's Reference Number | 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 | Result Forward URL (on browser) | https://merchant.co.id/nicepay-callback |
When Your callback already received callbackUrl, recommended to do verification using Status Inquiry - API E-Wallet.
CallBack Handling is very important to help minimize fraud. highly recommend to do 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 | 's Reference Number | 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 | Expiry Date (YYYYMMDD) | 20240626 |
paymentExpTm | N | 6 | Expiry Time (HH24MISS) | 093530 |
redirectUrlHttp | AN | 100 | Returns a universal link redirecting users to . | https://pay.uat.airpay.co.id/h5pay/example |
redirectUrlApp | AN | 100 | Returns a URL redirecting users to mobile apps. | For ShopeePay, this value will be deprecated |
redirectToken | AN | 2000 | | Used only for LinkAja |