Registration - API E-Wallet
Currently, NICEPAY is working with 5 E-Wallet channels that facilitate payment transactions in the Merchant business, namely:
- OVO
- LinkAja
- DANA
- ShopeePay
- AstraPay
In general, the integration stages for E-Wallet OVO, LinkAja, DANA, and ShopeePay are the same. However, there are significant differences in the integration of E-Wallet AstraPay. Specifically for AstraPay Registration and Payment, please visit AstraPay Registration - API E-Wallet and AstraPay Payment - API E-Wallet.
E-Wallet Registration API uses so that merchants can connect with the E-Wallet payment API system with the NICEPAY system. So, the payment system that has been provided and hosted from the merchant side can integrate with the system from NICEPAY. The following APIs can use for E-Wallet OVO, LinkAja, DANA, and ShopeePay.
API Endpoint | /nicepay/direct/v2/registration |
Request Method | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
Request Format | application/json |
- The following APIs can be implemented for E-Wallet OVO, LinkAja, DANA and ShopeePay.
- Please visit AstraPay Registration - API E-Wallet page to know about the integration of E-Wallet AstraPay registration.
- Please visit the AstraPay Payment - API E-Wallet page to know about the integration of E-Wallet AstraPay payment.
The following is a list of parameters for requesting registration of the E-Wallet payment method. This parameter uses in the API testing platform as one of the stages so that the Merchant's system can connect with services from NICEPAY.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20210315112359 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 05 | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount | 1000 |
referenceNo Required | ANS | 40 | Merchant's Ref No. | ORD54321 |
goodsNm Required | AN | 100 | Goods Name | Test Transaction Nicepay |
billingNm Required | A | 100 | Buyer Name | John Doe |
billingPhone Required | N | 15 | Buyer Phone No. | 08123456789 |
billingEmail Required | ANS | 40 | Buyer E-mail | |
billingAddr Required | AN | 100 | Buyer Address | Jalan Bukit Berbunga 22 |
billingCity Required | A | 50 | Buyer City | Jakarta |
billingState Required | A | 50 | Billing State | DKI Jakarta |
billingPostCd Required | N | 10 | Billing Post Number | 12345 |
billingCountry Required | A | 10 | Billing Country | Indonesia |
cartData | JSONstring | 4000 | Cart Data | { } |
mitraCd Required | A | 4 | Mitra Code | OVOE |
userIP Required | AN | 15 | User IP | 127.0.0.1 |
dbProcessUrl Required | ANS | 255 | Notification URL | https://merchant.com/dbProcessUrl |
merchantToken Required | AN | 255 | Merchant Token | a45e163042746131307bad89ef6cc0c517c136895a6cfe6cb77c4a62ce1ee5b3 |
deliveryNm | A | 30 | Delivery Name | John Doe |
deliveryPhone | N | 15 | Delivery Phone | 8124125931 |
deliveryAddr | AN | 100 | Delviery Address | Jln Merdeka Riau 161 |
deliveryCity | A | 50 | Delivery City | Riau |
deliveryState | A | 50 | Delivery State | Riau |
deliveryPostCd | N | 10 | Delivery Post Code | 14350 |
deliveryCountry | A | 10 | Delivery Country | Indonesia |
vat | N | 12 | Vat | 0 |
fee | N | 12 | Service Fee | 0 |
description | AN | 100 | Transaction Description | Test Transaction |
reqDomain | ANS | 100 | Request Domain | merchant.com |
reqServerIP | ANS | 15 | Request Server IP | 127.0.0.1 |
userIP Required | AN | 15 | User IP address | 127.0.0.1 |
reqClientVer | ANS | 50 | Client Version | 1.0 |
userSessionID | AN | 100 | User Session ID | userSessionID |
userAgent | ANS | 100 | User Agent | Mozilla |
userLanguage | A | 2 | User Language | en-US |
userAgent Required | ANS | 100 | User Agent Information | Mozilla |
NotaxAmt | N | 12 | Tax-free Amount | |
reqDt | N | 8 | Request Date (YYYYMMDD) | |
reqTm | N | 6 | Request Time (HH24MISS) | |
Please visit E-Wallet to learn general information regarding E-Wallet payment methods.
The following is the response parameter from the result of the request parameter to register on the E-Wallet payment method.
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST05202103151123583200 |
referenceNo | ANS | 40 | Merchant Ref. No | ORD54321 |
payMethod | N | 2 | 05 | |
amt | N | 12 | Payment Amount | 1000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20210315 |
transTm | N | 6 | Transction Time (HH24MISS) | 112358 |
description | AN | 100 | Transaction Description | null |
bankCd | A | 4 | null | |
vacctNo | N | 20 | Virtual Account | null |
mitraCd | A | 4 | OVOE | |
payNo | N | 12 | CVS Payment Number | null |
currency | A | 3 | Currency | IDR |
goodsNm | AN | 100 | Goods Name | Test Transaction Nicepa |
billingNm | A | 100 | Buyer Name | John Doe |
payValidDt | N | 8 | CVS expiry date (YYYYMMDD) (CVS) | null |
payValidTm | N | 6 | CVS expiry time (HH24MISS) (CVS) | null |
vacctValidDt | N | 8 | Expiry Date (YYYYMMDD) | null |
vacctValidTm | N | 6 | Expiry Time (HH24MISS) | null |
requestURL | ANS | 360 | Request URL | null |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) | null |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) | null |
qrContent | ANS | 360 | QR String in Plain Text | null |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes | null |
CartData in E-Wallet Registration contains the checkout items including their details and the price for each item.
Parameter | Description | Example |
Count | The total number of all card data | 2 |
Item | It is divided into 4 kinds of parameters, namely img_url, goods_name, goods_detail and goods_amt | - |
Detailed explanation on Item parameters
Parameter | Description | Example |
img_url | URL Goods Picture (Size 50px x 50px) | htttps://www.merchant.com/image_goods1.jpg |
goods_name | Goods Name | Nama Item-1 |
goods_detail | Goods Detail Description | Detail Item-1 |
goods_amt | Goods Price | 1000 |
goods_quantity | Goods Quantity | 1 |