Hands On API NICEPAY - NICEPAY Docs

Hands On API
15min
Enjoy our NICEPAY product and service with a single integrated API that is secure also easy to integrate into your business. Start the rapid integration process only in 15 minutes!
﻿
Precondition
﻿
MID/iMid (Merchant ID)
API Key (Merchant Key)
NICEPAY SDK  - Optional
Please check this Authentication﻿ page first to get the precondition requirements.
﻿
Payment Flow
﻿
Checkout Credit Card Payment Flow
﻿
Payment Flow step description of Credit Card redirect with 3Ds:
The Customer performs checkout.
The Customer sends checkout data to Merchant.
The Merchant requests checkout using Registration API to NICEPAY.
NICEPAY registers checkout data.
NICEPAY redirects payment to the NICEPAY page to Merchant.
The Merchant sends NICEPAY payment page to Customer.
The Customer chooses a payment method.
The Customer inputs card data.
The Customer sends card data information to NICEPAY.
NICEPAY processes FDS calculation.
NICEPAY requests 3Ds to Bank.
Bank performs 3Ds validation.
Bank sends response URL 3Ds to NICEPAY.
NICEPAY receives verification response.
NICEPAY redirects Customer to ACS authentication page.
Bank creates OTP response.
Bank sends OTP to Customer.
The Customer receives OTP.
The Customer inputs OTP.
The Customer sends OTP to Bank.
Bank performs OTP verification.
Bank sends 3Ds result to NICEPAY.
NICEPAY receives checking results.
NICEPAY requests payment to Bank.
Bank proceeds with the payment process.
Bank sends payment notification to NICEPAY.
NICEPAY redirects callbackUrl to Merchant.
The Merchant displays callbackUrl  result to Customer.
NICEPAY sends payment notifications to Merchant.
The Merchant receives the notification.
The Merchant performs request inquiry to NICEPAY.
NICEPAY receives the request.
NICEPAY automatically sends an inquiry response to Merchant.
The Merchant receives the last status.
The Merchant sends the transaction result page to Customer.
﻿
Payment Integration
﻿
On this process, You will use our Checkout﻿ product. All NICEPAY Checkout API﻿ transactions will redirect to NICEPAY Secure Payment Page as the payment process.
Follow these five easy steps to perform payment integration with NICEPAY.
Perform call Transaction Registration API.
Redirect to NICEPAY Secure Payment Page.
Process payment on NICEPAY Secure Payment Page.
NICEPAY will redirect end-user to Merchant callbackUrl.
Merchant perform call Status Inquiry API.
﻿
Transaction Registration
﻿
API End Point
﻿https://dev.nicepay.co.id/nicepay/redirect/v2/registration﻿
Request Method
﻿POST﻿
Header
Content-Type: application/json
Description
Perform Transction Registration
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request
Response
{
    "timeStamp":"20221012080918",
    "iMid":"IONPAYTEST",
    "payMethod":"00",
    "currency":"IDR",
    "amt":"10000",
    "referenceNo":"ORDER20221012080918",
    "callBackUrl":"https://dev.nicepay.co.id/IONPAY_CLIENT/paymentResult.jsp",
    "goodsNm":"Test Transaction Nicepay",
    "billingNm":"John Doe",
    "billingPhone":"081288998899",
    "billingEmail":"[email protected]",
    "billingAddr":"Jln. Raya Kasablanka Kav.88",
    "billingCity":"South Jakarta",
    "billingState":"DKI Jakarta",
    "billingPostCd":"12800",
    "billingCountry":"Indonesia",
    "deliveryNm":"[email protected]",
    "deliveryPhone":"081288998899",
    "deliveryAddr":"Jln. Raya Kasablanka Kav.88",
    "deliveryCity":"South Jakarta",
    "deliveryState":"DKI Jakarta",
    "deliveryPostCd":"12800",
    "deliveryCountry":"Indonesia",
    "dbProcessUrl":"https://merchant.com/api/dbProcessUrl/Notif",
    "merchantToken":"d8d0968892c568bc6ff5adc17cd755f85334a0b58fce85392682993a9ba653ed",
    "userIP":"127.0.0.1",
    "cartData": "{\"count\":3,\"item\":[{\"goods_id\":30,\"goods_name\":\"Beanie\",\"goods_type\":\"Accessories\",\"goods_amt\":1000,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.com/product/beanie/\"},{\"goods_id\":31,\"goods_name\":\"Belt\",\"goods_type\":\"Accessories\",\"goods_amt\":5000,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.store/product/belt/\"},{\"img_url\":\"http://www.jamgora.com/media/avatar/noimage.png\",\"goods_name\":\"Shipping Fee\",\"goods_id\":\"Shipping for Ref. No. 278\",\"goods_detail\":\"Flat rate\",\"goods_type\":\"Shipping with Flat rate\",\"goods_amt\":\"4000\",\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":\"1\",\"goods_url\":\"https://wwww.nicestore.store\"}]}",
    "sellers":"[{\"sellersId\":\"NICEPAY-NamaMerchant\",\"sellersNm\":\"NICEPAYSHOP\",\"sellersUrl\":\"http://nicestore.store/product/beanie/\",\"sellersEmail\":\"[email protected]\",\"sellersAddress\":{\"sellerNm\":\"NICEPAYSHOP\",\"sellerLastNm\":\"NICEPAYSHOP\",\"sellerAddr\":\"Jln. Kasablanka Kav 88\",\"sellerCity\":\"Jakarta\",\"sellerPostCd\":\"14350\",\"sellerPhone\":\"082111111111\",\"sellerCountry\":\"ID\"}}]",
    "instmntType": "2",
    "instmntMon": "1",
    "recurrOpt":"0",
    "bankCd":"",
    "mitraCd":"",
    "merFixAcctId":"",
    "vacctValidDt":"",
    "vacctValidTm":""
}
{
    "timeStamp":"20221012080918",
    "iMid":"IONPAYTEST",
    "payMethod":"00",
    "currency":"IDR",
    "amt":"10000",
    "referenceNo":"ORDER20221012080918",
    "callBackUrl":"https://dev.nicepay.co.id/IONPAY_CLIENT/paymentResult.jsp",
    "goodsNm":"Test Transaction Nicepay",
    "billingNm":"John Doe",
    "billingPhone":"081288998899",
    "billingEmail":"john.doe@example.com",
    "billingAddr":"Jln. Raya Kasablanka Kav.88",
    "billingCity":"South Jakarta",
    "billingState":"DKI Jakarta",
    "billingPostCd":"12800",
    "billingCountry":"Indonesia",
    "deliveryNm":"delivery@example.com",
    "deliveryPhone":"081288998899",
    "deliveryAddr":"Jln. Raya Kasablanka Kav.88",
    "deliveryCity":"South Jakarta",
    "deliveryState":"DKI Jakarta",
    "deliveryPostCd":"12800",
    "deliveryCountry":"Indonesia",
    "dbProcessUrl":"https://merchant.com/api/dbProcessUrl/Notif",
    "merchantToken":"d8d0968892c568bc6ff5adc17cd755f85334a0b58fce85392682993a9ba653ed",
    "userIP":"127.0.0.1",
    "cartData": "{\"count\":3,\"item\":[{\"goods_id\":30,\"goods_name\":\"Beanie\",\"goods_type\":\"Accessories\",\"goods_amt\":1000,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.com/product/beanie/\"},{\"goods_id\":31,\"goods_name\":\"Belt\",\"goods_type\":\"Accessories\",\"goods_amt\":5000,\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":1,\"goods_url\":\"http://www.nicestore.store/product/belt/\"},{\"img_url\":\"http://www.jamgora.com/media/avatar/noimage.png\",\"goods_name\":\"Shipping Fee\",\"goods_id\":\"Shipping for Ref. No. 278\",\"goods_detail\":\"Flat rate\",\"goods_type\":\"Shipping with Flat rate\",\"goods_amt\":\"4000\",\"goods_sellers_id\":\"NICEPAY-NamaMerchant\",\"goods_sellers_name\":\"NICEPAYSHOP\",\"goods_quantity\":\"1\",\"goods_url\":\"https://wwww.nicestore.store\"}]}",
    "sellers":"[{\"sellersId\":\"NICEPAY-NamaMerchant\",\"sellersNm\":\"NICEPAYSHOP\",\"sellersUrl\":\"http://nicestore.store/product/beanie/\",\"sellersEmail\":\"Nicepay@nicepay.co.id\",\"sellersAddress\":{\"sellerNm\":\"NICEPAYSHOP\",\"sellerLastNm\":\"NICEPAYSHOP\",\"sellerAddr\":\"Jln. Kasablanka Kav 88\",\"sellerCity\":\"Jakarta\",\"sellerPostCd\":\"14350\",\"sellerPhone\":\"082111111111\",\"sellerCountry\":\"ID\"}}]",
    "instmntType": "2",
    "instmntMon": "1",
    "recurrOpt":"0",
    "bankCd":"",
    "mitraCd":"",
    "merFixAcctId":"",
    "vacctValidDt":"",
    "vacctValidTm":""
}
﻿
Access further API specification on Registration - API Checkout﻿.
﻿
Transaction Payment
﻿
API End Point
﻿https://dev.nicepay.co.id/nicepay/redirect/v2/payment﻿
Request Method
﻿GET﻿
Header
﻿Content-Type: application/Form-UrlEncoded﻿
Description
Perform Transction Registration
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
After receive response, you can redirect Customer to NICEPAY payment page. That URL is a combination of paymentURL + tXid as response parameter that will has a result like this example:https://dev.nicepay.co.id/nicepay/redirect/v2/payment?tXid=IONPAYTEST00202212191025073439 
NICEPAY Checkout Payment Page
﻿
Example at the above is Transaction Payment using Credit Card payment method. Find the complete API specification on Credit Card - API Checkout﻿.
Success Payment Page
﻿
﻿
Callback Handling
﻿
After User choose Credit Card as the payment method, User will redirect to Merchant page by callbackUrl with POST method and sending parameter.
Callback Handling
﻿
When Callback to Your callbackUrl have been received, we strongly recommend Merchant to verify status by using Status Inquiry - API Credit Card﻿.
CallBack Handling is very helpful to minimize Fraud actions. We strongly recommend Merchants to verify the callBack parameter.
callbackUrl
Callback Parameter
{
    "resultCd":"0000",
    "resultMsg":"SUCCESS",
    "tXid":"IONPAYTEST01202212141112221428",
    "referenceNo":"",
    "payMethod":"01",
    "amt":"10000",
    "transDt":"20221212",
    "transTm":"121212",
    "description":"Testing Credit Card Transaction",
    "authNo":"080623",
    "issuBankCd":"OTHR"
    "acquBankCd":"BMRI",
    "cardNo":"453211*****1111",
    "goodsNm":"Test Transaction Nicepay"
    "billingNm":"John Doe",
    "currency":"IDR",
    "timeStamp":"20221212121212",
    "merchantToken":"2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6",
    "cardExpYymm":"2712",
    "instmntMon":"1",
    "instmntType":"1",
    "ccTransType":"1"
}
{
    "resultCd":"0000",
    "resultMsg":"SUCCESS",
    "tXid":"IONPAYTEST01202212141112221428",
    "referenceNo":"",
    "payMethod":"01",
    "amt":"10000",
    "transDt":"20221212",
    "transTm":"121212",
    "description":"Testing Credit Card Transaction",
    "authNo":"080623",
    "issuBankCd":"OTHR"
    "acquBankCd":"BMRI",
    "cardNo":"453211*****1111",
    "goodsNm":"Test Transaction Nicepay"
    "billingNm":"John Doe",
    "currency":"IDR",
    "timeStamp":"20221212121212",
    "merchantToken":"2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6",
    "cardExpYymm":"2712",
    "instmntMon":"1",
    "instmntType":"1",
    "ccTransType":"1"
}
﻿
Congratulations! You have successfully perform an integration trial!
Explore further through the link below.
﻿
See Also
Find out explanation about payment method and custom product on Payment﻿ page.
Find further explanation related product available on NICEPAY at the Checkout﻿ page.
Visit the Payout﻿ page to learn the detail of API used.
Visit the Messaging﻿ page to learn about NICEPAY’s messaging service.
﻿
Bank Indonesia already release API Standard relate to the Payment listed on Peraturan Anggota Dewan Gubernur No 23/15/PADG/2021 about Standar Nasional Open Application Interface Pembayaran (SNAP) Implementation.
As the form of suppport and compliance to Bank Indonesia Rules, NICEPAY drives all Merchant to conduct the migration to API SNAP BI.
All Merchants aim to complete the API SNAP BI migration on June 2024.
API End Point	https://dev.nicepay.co.id/nicepay/redirect/v2/registration
Request Method	POST
Header	Content-Type: application/json
Description	Perform Transction Registration
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
API End Point	https://dev.nicepay.co.id/nicepay/redirect/v2/payment
Request Method	GET
Header	Content-Type: application/Form-UrlEncoded
Description	Perform Transction Registration
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Hands On API

Precondition

Payment Flow

Payment Integration

Transaction Registration

Transaction Payment

Callback Handling

See Also

Welcome to NICEPAY DOCS
