Registration - API Checkout
The purpose of this step on Registration - API Checkout is to register a checkout request from your Customer to us. So that your Customer can pay the transaction amount billed on the payment page provided by NICEPAY.
Based on the principle, all payment methods on the Checkout API have the same process. The difference is just the parameter on each payment method.
When the Customer proceeds with the Checkout process, the system proceeds the order registration firsthand before the Customer can do the payment process on the chosen payment method through the received payment link.
Please visit the Payment - API Checkout page to know further explanations related API specific for payment.
The following is the payment that the Customer can choose to proceed with the payment process, there are:
Please continue reading this page for more further detail about API Registration.
To be able uses all payment methods on Checkout API, you are required to register the transaction with this Checkout Registration API. Here are the parameters:
API URL | /nicepay/redirect/v2/registration |
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256 (timestamp+ iMid+ referenceNo+ amt+ merchantKey) |
Parameter | Type | Size | Description | Remark |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20230516660517 |
payMethod Required | N | 2 | 00 | |
bankCd | A | 4 | Bank Code | CENA |
currency Required | AN | 3 | Currency | IDR |
amt | N | 12 | Transaction Amount | 10000 |
referenceNo Required | ANS | 40 | Merchant Order Number | MerchantReferenceNumber001 |
merchantToken Required | AN | 255 | Merchant Token | 4686062c297a3e48cf385953f411bbd48753bb70b041f2113a3e7c2e99c54f3c |
callBackUrl | AN | 255 | Payment Result Forward URL | https://www.merchant.com/callbackUrl/ |
dbProcessUrl | AN | 255 | Payment Notification URL | https://www.merchant.com/dbProcessUrl |
goodsNm Required | AN | 100 | Goods Name | Merchant Goods 1 |
mitraCd Required For CVS, E-Wallet & Payloan | AN | 4 | Mitra Code | DANA |
vacctValidDt Required For VA | N | 8 | VA Expiry Date (YYYYMMDD) | 20230531 |
vacctValidTm Required For VA | N | 8 | VA Expiry Time (HH24MISS) | 235959 |
description Required | AN | 100 | Transaction Description | This Is The Description Of The Payment |
billingNm Required | A | 100 | Billing Name | John Doe |
billingPhone Required | N | 15 | Billing Phone | 08123456789 |
billingEmail Required | AN | 40 | Billing E-mail | |
billingAddr | AN | 100 | Billing Address | Jln. Raya Casablanka Kav.88 |
billingCity Required | A | 50 | Billing City | South Jakarta |
billingState Required | A | 50 | Billing State | DKI Jakarta |
billingPostCd Required | N | 10 | Billing Post Number | 10200 |
billingCountry Required | A | 10 | Billing Country | Indonesia |
userIP | AN | 15 | User IP | 127.0.0.1 |
cartData Required | AN | 4000 | Cart Data | {\"count\":\"1\",\"item\":[{\"goods_id\":\"BB12345678\",\"goods_detail\":\"BB123456\",\"goods_name\":\"iPhone5S\",\"goods_amt\":\"10000\",\"goods_type\":\"Smartphone\",\"goods_url\":\"http://merchant.com/cellphones/iphone5s_64g\",\"goods_quantity\":\"1\",\"goods_sellers_id\":\"SEL123\",\"goods_sellers_name\":\"Sellers1\"}]} |
deliveryNm | A | 30 | Delivery Name | Merchant's Name |
deliveryPhone | N | 15 | Delivery Phone | 08123456789 |
deliveryAddr | AN | 100 | Delivery Address | Jln. Dr.Saharjo No.88 |
deliveryCity | A | 50 | Delivery City | South Jakarta |
deliveryState | A | 50 | Delivery State | DKI Jakarta |
deliveryPostCd | N | 10 | Delivery Post Number | 10201 |
deliveryCountry | A | 10 | Delivery Country | Indonesia |
vat | N | 12 | Value Added Tax (VAT) | (empty) |
fee | N | 12 | Service Fee | (empty) |
notaxAmt | N | 12 | Tax Free Amount | (empty) |
reqDt | N | 8 | Request Date (YYYYMMDD) | (empty) |
reqTm | N | 6 | Request Time (HH24MISS) | (empty) |
reqDomain | AN | 100 | Request Domain | (empty) |
reqServerIP | AN | 15 | Request Server IP | (empty) |
reqClientVer | AN | 50 | Request Client Version | (empty) |
userSessionID | AN | 100 | User Session ID | (empty) |
userAgent | AN | 100 | User Agent Information | (empty) |
userLanguage | A | 2 | User Language | (empty) |
Parameter | Type | Size | Description | Remark |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | SUCCESS | |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202305161555223616 When Success |
referenceNo | ANS | 40 | Merchant Order No | MerchantReferenceNumber001 |
payMethod | N | 2 | 00 When Success | |
amt | N | 12 | Amount | 10000 When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20230516 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 135959 When Success |
description | AN | 100 | Transaction Description | This Is The Description Of The Payment When Success |
currency | AN | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Merchant Goods 1 When Success |
billingNm | A | 100 | Buyer Name | John Doe When Success |
payValidDt | N | 8 | CVS Expiry Date (YYYYMMDD) | null |
payValidTm | N | 6 | CVS Expiry Time (HH24MISS) | null |
paymentURL | AN | 40 | Redirect URL NICEPAY | https://www.nicepay.co.id/nicepay/redirect/v2/payment |
After your transaction has been registered, direct your Customer to our Payment page to proceed with the payment. Please check the Payment - API Checkout page to view the details.
The Card Data on Checkout API is useful for declaring what items will be checked out along with item details and prices per item. This Card Data applies to all payment methods, except payment method using Payloan because the Payloan payment method has special Car Data.
- cartData must be released in the string form.
- Special characters are not supported in cartData.
- Make sure that count is the same as the number of item object.
- Make sure that goods_amt x goods_quantity is the same as the amt parameter.
Parameter | Description | Remark |
Count | Total number of all cart data | 2 |
Item | Divided into 5 kinds of parameters, namely img_url, goods_name, goods_detail, goods_amt, and goods_quantity | - |
Detailed explanation of the Item parameters.
Parameter | Description | Remark |
img_url | Goods Image URL (Size 50px x 50px) | http://img.aaa.com/ima1.jpg |
goods_name | Goods Name | Item 1 Name |
goods_detail | Goods Detail Description | Item 1 Detail |
goods_amt | Goods Amount | 700 |
goods_quantity | Goods Quantity | 1 |
Parameter | Description |
count | Total cart data count |
item | List of goods |
item -> goods_id | Goods ID |
item -> goods_detail | Goods Detail |
item -> goods_name | Goods Name |
item -> goods_amt | Goods Amount |
item -> goods_type | Goods Type |
item -> goods_url | Goods URL |
item -> goods_quantity | Goods Quantity |
item -> goods_sellers_id | Seller's ID |
item -> goods_sellers_name | Seller's Name |
cartData is mandatory to be released in the string form.
- cartData is specifically for Payloan.
- Make sure the count parameters are based on the goods' type number.
- Make sure the goods_sellers_id and goods_sellers_name are contained according to the sellers on Registration.
Parameter | Description |
sellersId | Seller's ID |
sellersNm | Seller's Name |
sellersEmail | Seller's E-mail |
sellersUrl | Seller's Url |
sellersAddress -> sellerNm | Seller's Name |
sellersAddress -> sellerLastNm | Seller's Last Name |
sellersAddress -> sellerAddr | Seller's Address |
sellersAddress -> sellerCity | Seller's City |
sellersAddress -> sellerPostCd | Seller's Postal Code |
sellersAddress -> sellerPhone | Seller's Phone |
sellersAddress -> sellerCountry | Seller's Country |