Registration - API Paylater

21 min

Tentang API for Paylater Registration

API ini digunakan oleh Merchant untuk mendaftarkan transaksi kepada sistem NICEPAY agar dapat melakukan pendaftaran transaksi.

API for Paylater Registration

API Paylater Registration digunakan supaya Merchant dapat terhubung dengan sistem API pembayaran Paylater dari NICEPAY. Sehingga sistem pembayaran yang sudah disediakan dan di-host dari sisi Merchant dapat terintegrasi dengan sistem dari NICEPAY. API berikut dapat digunakan untuk registrasi Indodana, Akulaku, dan Kredivo.

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

Berikut ini adalah daftar parameter untuk melakukan request registrasi metode pembayaran Paylater. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari 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, jika instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months Aturan dan Limitasi Paylater	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\"}}]

Silakan kunjungi Paylater untuk mempelajari informasi umum mengenai metode pembayaran Paylater.

Response Parameter for Paylater Registration

Berikut adalah response parameter dari hasil request parameter untuk mendaftarkan metode pembayaran Paylater.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
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 Number	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

{
    "timeStamp": "20220131125959",
    "iMid": "PAYLOANTES",
    "payMethod": "06",
    "currency": "IDR",
    "amt": "10000",
    "referenceNo": "ORD12345",
    "goodsNm": "Test Transaction Nicepay",
    "billingNm": "John Doe",
    "billingPhone": "08123456789",
    "billingEmail": "[email protected]",
    "billingAddr": "Jalan Bukit Berbunga 22",
    "billingCity": "Jakarta",
    "billingState": "DKI Jakarta",
    "billingPostCd": "12345",
    "billingCountry": "Indonesia",
    "deliveryNm": "[email protected]",
    "deliveryPhone": "08123456789",
    "deliveryAddr": "Jalan Bukit Berbunga 22",
    "deliveryCity": "Jakarta",
    "deliveryState": "DKI Jakarta",
    "deliveryPostCd": "12345",
    "deliveryCountry": "Indonesia",
    "dbProcessUrl": "https://merchant.com/api/dbProcessUrl/Notif",
    "description": "",      
    "merchantToken":"9b38b12e83b6ee124d4b549238f232c6179b168effc4ffb7f64d00c15f08e230",
    "reqDomain": "merchant.com",
    "reqServerIP": "127.0.0.1",
    "reqClientVer": "",
    "userIP": "127.0.0.1",
    "userSessionID": "697D6922C961070967D3BA1BA5699C2C",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
    "userLanguage": "ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
    "cartData": "{\"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/\"},{\"goods_id\":31,\"goods_name\":\"Belt\",\"goods_type\":\"Accessories\",\"goods_amt\":4500,\"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\":\"500\",\"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",
    "mitraCd": "KDVI"
}

Cart Data Paylater

Masing-masing Mitra yang bekerja sama dengan NICEPAY memiliki ketentuan yang berbeda-beda. Berikut adalah rincian ketentuan dari masing-masing Mitra.

Indodana

CartData pada Registrasi Paylater berguna untuk mendeklarasikan item yang akan di-checkout berserta rincian item dan harga per item-nya.

Parameter	Deskripsi	Contoh
Count	Total jumlah dari keseluruhan cart data	2
Item	Terbagi menjadi 4 macam parameter, yaitu img_url, goods_name, goods_detail dan goods_amt	-

Penjelasan rincian pada parameter Item.

Parameter	Deskripsi	Contoh / Catatan
goods_id	ID Barang	AA12345
goods_name	Nama Barang	Beanie
goods_amt	Harga Barang	5000
goods_type	Tipe Barang	others
goods_quantity	Jumlah Barang	1
goods_url	Tautan Barang	http://nicestore.go/product/beanie/
goods_sellers_id	ID Penjual Barang	NICEPAY-NamaMerchant
goods_sellers_name	Nama Penjual Barang	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 pada Registrasi Paylater berguna untuk mendeklarasikan item apa saja yang akan di-checkout berserta rincian dan harga per item.

Parameter	Deskripsi	Contoh
Count	Total jumlah keseluruhan cart data	2
Item	Parameter yang berisi rincian cart data, seperti img_url, goods_name, goods_detail , dan goods_amt	-

Penjelasan rinci pada parameter Item.

Parameter	Deskripsi	Contoh / Catatan
goods_id	ID Barang	AA12345
goods_name	Nama Barang	Beanie
goods_amt	Harga Barang	5000
goods_type	Tipe Barang	others
goods_detail	Rincian Barang	AA1345678
goods_quantity	Jumlah Barang	1
goods_url	Tautan Barang	http://nicestore.go/product/beanie/
goods_sellers_id	ID Penjual Barang	NICEPAY-NamaMerchant
goods_sellers_name	Nama Penjual Barang	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 pada Registrasi Paylater berguna untuk mendeklarasikan item apa saja yang akan di-checkout berserta rincian dan harga per item.

Parameter	Deskripsi	Contoh
Count	Total jumlah keseluruhan cart data	3
Item	Parameter yang berisi rincian cart data, seperti img_url, goods_name, goods_detail , dan goods_amt	-

Penjelasan rinci pada parameter Item.

Parameter	Deskripsi	Contoh / Catatan
goods_id	ID Barang	AA12345 Dapat berisi kode yang berasal dari Merchant, taxfee, shippingfee atau discount
goods_name	Nama Barang	Ant Life
goods_amt	Harga Barang	200000
goods_type	Tipe Barang	others
goods_detail	Rincian Barang	AA1345678
goods_quantity	Jumlah Barang	1
goods_url	Tautan Barang	http://nicestore.go/product/book/
goods_sellers_id	ID Penjual Barang	NICEPAY-NamaMerchant
goods_sellers_name	Nama Penjual Barang	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"
    }
  ]
}

Parameter goods_id pada CartData mempengaruhi perhitungan amt dengan rumus seperti berikut:

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

Contoh:

Berikut perhitungan berdasarkan data dari 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 berisi data informasi Seller yang dikirimkan oleh Seller kepada Partner NICEPAY untuk digunakan sebagai validasi Seller saat bertransaksi menggunakan metode pembayaran Paylater.

Parameter	Deskripsi	Contoh
sellersId	ID Seller	SEL123
sellersNm	Nama Seller	Sellers 1
sellersEmail	Email Seller	[email protected]
sellersUrl	Tautan Seller	http://nicestore.store
sellersAddress -> sellerNm	Nama Seller	Sellers
sellersAddress -> sellerLastNm	Nama Belakang Seller	1
sellersAddress -> sellerAddr	Alamat Seller	jalan berbangsa 1
sellersAddress -> sellerCity	Kota Asal Seller	Jakarta Barat
sellersAddress -> sellerPostCd	Kode Pos Seller	12344
sellersAddress -> sellerPhone	Telepon Seller	08123456789
sellersAddress -> sellerCountry	Negara Asal Seller	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"
    }
  }
]