Registration - API Paylater

21 min

About API for Paylater Registration

This API uses by Merchants to register transactions with the NICEPAY system so that they can register transactions.

API for Paylater Registration

The Paylater Registration API uses so that the Merchants can connect to the Paylater 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+referenceNo+amt+merchantKey)
Request Format	application/json

Request Parameter for Paylater Registration

The following is a list of parameters for requesting registration of the Paylater 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	Payment Method Code	06
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount	10000
referenceNo Required	ANS	40	Merchant's Reference Number	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 Number	08123456789
billingEmail Required	ANS	40	Buyer E-Mail	[email protected]
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, Paylater,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 Required	A	30	Delivery Name	[email protected]
deliveryPhone Required	N	15	Delivery Phone	08123456789
deliveryAddr Required	AN	100	Delviery Address	Jalan Bukit Berbunga 22
deliveryCity Required	A	50	Delivery City	Jakarta
deliveryState Required	A	50	Delivery State	DKI Jakarta
deliveryPostCd Required	N	10	Delivery Post Code	12345
deliveryCountry Required	A	10	Delivery Country	Indonesia
mitraCd Required	N	2	Mitra Code	KDVI
instmntType Required	N	8	Installment Type Code	2
instmntMon Required	N	6	1: 1 Month/Full Payment, if instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months Paylater Rule and Limitation	3
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 Required	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 Paylater section to learn general information about the Paylater payment method.

Response Parameter for Paylater Registration

The following is the response parameter from the result of the request parameter for registering the Paylater payment method.

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	PAYLOANTES06202212051018325178
referenceNo	ANS	40	Merchant Reference Number	ORD12345
payMethod	N	2	Payment Method Code	06
amt	N	12	Payment Amount	10000
transDt	N	8	Transaction Date (YYYYMMDD)	null
transTm	N	6	Transaction Time (HH24MISS)	null
description	AN	100	Transaction Description	null
bankCd	A	4	Bank Code	null
vacctNo	N	20	Virtual Account	null
mitraCd	A	4	Mitra Code	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

Sample JSON for Paylater Registration

{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "PAYLOANTES06202212051018325178",
    "referenceNo": "ORD12345",
    "payMethod": "06",
    "amt": "10000",
    "transDt": null,
    "transTm": null,
    "description": null,
    "bankCd": null,
    "vacctNo": null,
    "mitraCd": "KDVI",
    "payNo": null,
    "currency": null,
    "goodsNm": null,
    "billingNm": null,
    "vacctValidDt": null,
    "vacctValidTm": null,
    "payValidDt": null,
    "payValidTm": null,
    "requestURL": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "qrContent": null,
    "qrUrl": null
}

Cart Data Paylater

Each Partner that works together with NICEPAY has different condition. Following are detailed terms for each Partner.

Indodana

CartData in Paylater 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 parameter s.

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	http://nicestore.go/product/beanie/
goods_sellers_id	Goods Seller ID	NICEPAY-NamaMerchant
goods_sellers_name	Goods Seller Name	NICEPAYSHOP

{
	"count":2,
	"item":[
		{
			"goods_id":"AA12345",
			"goods_name":"Beanie",
			"goods_amt":"5000",
			"goods_type":"others",
			"goods_quantity":1,
			"goods_url":"http://nicestore.go/product/beanie/"
			"goods_sellers_id":"NICEPAY-NamaMerchant",
			"goods_sellers_name":"NICEPAYSHOP"
		},
		{
			"goods_id":"BB12345",
			"goods_name":"Belt",
			"goods_amt":"5000",
			"goods_type":"others",
			"goods_quantity":"1",
			"goods_url":"http://nicestore.go/product/belt/",
			"goods_sellers_id":"NICEPAY-NamaMerchant",
			"goods_sellers_name":"NICEPAYSHOP"
		}
	]
}

Akulaku

CartData in Paylater 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

{
	"count":"2",
	"item":[
		{
			"goods_id":"AA12345",
			"goods_name":"Beanie",
			"goods_amt":"5000",
			"goods_type":"others",
			"goods_detail":"AA1345678",
			"goods_quantity":"1",
			"goods_url":"http://nicestore.go/product/beanie/",
			"goods_sellers_id":"NICEPAY-NamaMerchant",
			"goods_sellers_name":"NICEPAYSHOP"
		},
		{
			"goods_id":"BB12345",
			"goods_name":"Belt",
			"goods_amt":"5000",
			"goods_type":"others",
			"goods_detail":"BB12345678",
			"goods_quantity":"1",
			"goods_url":"http://nicestore.go/product/belt/",
			"goods_sellers_id":"NICEPAY-NamaMerchant",
			"goods_sellers_name":"NICEPAYSHOP"
		}
	]
}

Kredivo

CartData in Paylater Registration is useful for declaring what items will check out along with item details and the price for each item.

Parameter	Deskripsi	Contoh
Count	The total number of all card data	3
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 It can contain code from Merchant, taxfee, shippingfee or discount
goods_name	Goods Name	Ant Life
goods_amt	Goods Price	200000
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

{
  "count": "3",
  "item": [
    {
      "goods_id": "AA12345",
      "goods_detail": "AA1345678",
      "goods_name": "Ant Life",
      "goods_amt": 200000,
      "goods_type": "Book",
      "goods_url": "http://nicestore.go/product/book/",
      "goods_quantity": 1,
      "goods_sellers_id": "NICEPAY-NamaMerchant",
      "goods_sellers_name": "NICEPAYSHOP"
    },
    {
      "goods_id": "taxfee",
      "goods_detail": "",
      "goods_name": "",
      "goods_amt": 5000,
      "goods_type": "",
      "goods_url": "",
      "goods_quantity": 1,
      "goods_sellers_id": "NICEPAY-NamaMerchant",
      "goods_sellers_name": "NICEPAYSHOP"
    },
    {
      "goods_id": "discount",
      "goods_detail": "",
      "goods_name": "Discount",
      "goods_amt": 20000,
      "goods_type": "",
      "goods_url": "",
      "goods_quantity": 1,
      "goods_sellers_id": "NICEPAY-NamaMerchant",
      "goods_sellers_name": "NICEPAYSHOP"
    },
    {
      "goods_id": "shippingfee",
      "goods_detail": "Biaya Pengiriman",
      "goods_name": "Biaya Pengiriman",
      "goods_amt": 10000,
      "goods_type": "Book",
      "goods_url": "http://nicestore.go/product/book/",
      "goods_quantity": 1,
      "goods_sellers_id": "NICEPAY-NamaMerchant",
      "goods_sellers_name": "NICEPAYSHOP"
    }
  ]
}

goods_id parameter on CartData affect amt calculation with the following formula:

amt = (shipmentfee + taxfDDee + goods_amt + ... ) - discount

Example:

Following is the calculation based from cartData Paylater Kredivo Registration.

shipmentfee = 10000

taxfee = 5000

goods_amt = 200000

discount = 20000

amt = (10000 + 5000 + 200000) - 20000 = 215000 - 20000 = 195000

Paylater Seller Data

Paylater Seller Data contains Seller data information sent from Seller to NICEPAY Partner to be used as Seller validation during transaction using Paylater payment method.

Parameter	Description	Example
sellersId	Seller ID	SEL123
sellersNm	Seller Name	Sellers 1
sellersEmail	Seller E-Mail	[email protected]
sellersUrl	Seller Link	http://nicestore.store
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

[
  {
    "sellersId": "SEL123",
    "sellersNm": "Sellers 1",
    "sellersEmail": "[email protected]",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "1",
      "sellerAddr": "jalan berbangsa 1",
      "sellerCity": "Jakarta Barat",
      "sellerPostCd": "12344",
      "sellerPhone": "08123456789",
      "sellerCountry": "ID"
    }
  },
  {
    "sellersId": "SEL124",
    "sellersNm": "Sellers 2",
    "sellersEmail": "[email protected]",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "2",
      "sellerAddr": "jalan berkelok 3",
      "sellerCity": "Jakarta Utara",
      "sellerPostCd": "12222",
      "sellerPhone": "081255556789",
      "sellerCountry": "ID"
    }
  }
]