Registration - API Payloan
This API uses by Merchants to register transactions with the NICEPAY system so that they can register transactions.
The Payloan Registration API uses so that the Merchants can connect to the Payloan payment API system from NICEPAY. So that 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 Indodana, Akulaku, and Kredivo Registrations.
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 is a list of parameters for requesting registration of the Payloan 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 | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20220131125959 |
iMid Required | AN | 10 | Merchant ID | PAYLOANTES |
payMethod Required | N | 2 | 06 | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount | 10000 |
referenceNo Required | ANS | 40 | Merchant's RefNo. | ORD12345 |
callBackUrl | ANS | 255 | Payment Result URL | |
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 Required | JSONstring | 4000 | Cart Data | {"count":3,"item":[{"goods_id":30,"goods_name":"Beanie","goods_type":"Accessories","goods_amt":5000,"goods_sellers_id":"NICEPAY-NamaMerchant","goods_sellers_name":"NICEPAYSHOP","goods_quantity":1,"goods_url":"http://www.nicestore.com/product/beanie/"},..]} |
userIP Required for CC, E-Wallet, Payloan,QRIS | AN | 15 | User IP | 127.0.0.1 |
dbProcessUrl Required | ANS | 255 | Notification URL | https://merchant.com/dbProcessUrl |
merchantToken Required | AN | 255 | Merchant Token | 9b38b12e83b6ee124d4b549238f232c6179b168effc4ffb7f64d00c15f08e230 |
deliveryNm | A | 30 | Delivery Name | |
deliveryPhone | N | 15 | Delivery Phone | 08123456789 |
deliveryAddr | AN | 100 | Delviery Address | Jalan Bukit Berbunga 22 |
deliveryCity | A | 50 | Delivery City | Jakarta |
deliveryState | A | 50 | Delivery State | DKI Jakarta |
deliveryPostCd | N | 10 | Delivery Post Code | 12345 |
deliveryCountry | A | 10 | Delivery Country | Indonesia |
mitraCd Required | N | 2 | Mitra Code | KDVI |
instmntType Required | N | 8 | Request Date (YYYYMMDD) | 2 |
instmntMon Required | N | 6 | Request Time (HH24MISS) | 1 |
userSessionID | AN | 255 | ID user session | 697D6922C961070967D3BA1BA5699C2C |
userAgent | ANS | 255 | User agent | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36 |
userLanguage | ANS | 255 | User language | ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4 |
sellers | JSON String | 4000 | Seller data | [{\"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\"}}] |
Please visit Payloan section to learn general information about the Payloan payment method.
The following is the response parameter from the result of the request parameter for registering the Payloan 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 | PAYLOANTES06202212051018325178 |
referenceNo | ANS | 40 | Merchant Ref. No | ORD12345 |
payMethod | N | 2 | 06 | |
amt | N | 12 | Payment Amount | 10000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | null |
transTm | N | 6 | Transction Time (HH24MISS) | null |
description | AN | 100 | Transaction Description | null |
bankCd | A | 4 | null | |
vacctNo | N | 20 | Virtual Account | null |
mitraCd | A | 4 | KDVI | |
payNo | N | 12 | CVS Payment Number | null |
currency | A | 3 | Currency | null |
goodsNm | AN | 100 | Goods Name | null |
billingNm | A | 100 | Buyer Name | null |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) | null |
payValidTm | 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 |
Each Partner that works together with NICEPAY has different condition. Following are detailed terms for each Partner.
CartData in Payloan Registration is useful for declaring items that will check out along with item details and the price per item.
Parameter | Description | Contoh |
Count | The total number of all card data | 2 |
Item | It divides into 4 kinds of parameters, namely img_url, goods_name, goods_detail and goods_amt | - |
Detailed explanation on Item parameters
Parameter | Description | Example / Notes |
goods_id | Goods ID | AA12345 |
goods_name | Goods name | Beanie |
goods_amt | Goods price | 5000 |
goods_type | Goods type | others |
goods_quantity | Goods quantity | 1 |
goods_url | Goods link | |
goods_sellers_id | Goods seller id | NICEPAY-NamaMerchant |
goods_sellers_name | Goods seller name | NICEPAYSHOP |
CartData in Payloan Registration is useful for declaring what items will check out along with item details and the price for each item.
Parameter | Description | Contoh |
Count | The total number of all card data | 2 |
Item | It divides into 4 kinds of parameters, namely img_url, goods_name, goods_detail , and goods_amt | - |
Detailed explanation on Item parameters
Parameter | Description | Example / Notes |
goods_id | Goods ID | AA12345 |
goods_name | Goods name | Beanie |
goods_amt | Goods price | 5000 |
goods_type | Goods type | others |
goods_detail | Goods detail | AA1345678 |
goods_quantity | Goods quantity | 1 |
goods_url | Goods link | http://nicestore.go/product/beanie/ |
goods_sellers_id | Goods seller id | NICEPAY-NamaMerchant |
goods_sellers_name | Goods seller name | NICEPAYSHOP |
Payloan Seller Data contains seller data information sent from seller to NICEPAY Partner to be used as seller validation during transaction using Payloan payment method.
Parameter | Description | Example |
sellersId | Seller ID | SEL123 |
sellersNm | Seller Name | Sellers 1 |
sellersEmail | Seller E-mail | |
sellersUrl | Seller Link | |
sellersAddress -> sellerNm | Seller Name | Sellers |
sellersAddress -> sellerLastNm | Seller Last Name | 1 |
sellersAddress -> sellerAddr | Seller Address | jalan berbangsa 1 |
sellersAddress -> sellerCity | Seller City Origin | Jakarta Barat |
sellersAddress -> sellerPostCd | Seller Postal Code | 12344 |
sellersAddress -> sellerPhone | Seller Phone number | 08123456789 |
sellersAddress -> sellerCountry | Seller Country Origin | ID |