NICEPAY API
API Versi 1

V1 Professional

23min

Bagian ini memuat referensi   versi sebelumnya.  merekomendasikan untuk menggunakan  terbaru untuk digunakan.



NICEPAY Professional



Langkah dalam menggunakan  Professional:

  1.  request .
  2.  mengalihkan  menuju   Secure .
  3. Selesaikan  pada   Secure .
  4.  akan mengalihkan  kembali kepada  dengan callbackUrl untuk memberikan  .
Guide Flow v1 Professional
Guide Flow v1 Professional


Deskripsi langkah:

  1.  melakukan checkout.
  2. Card Data dikirimkan dari  kepada  untuk membuat pesanan.
  3.  mengirimkan data kartu kepada .
  4.  akan membuat   dan tXid.
  5.  mengirimkan   dan tXid kepada .
  6.  menerima   dan tXid dan menyimpan tXid ke dalam database.
  7.  akan diarahkan menuju  .
  8.  mengunjungi    dan memasukkan rincian pesanan.
  9.  mengirimkan  kepada .
  10.  mengirimkan hasil .
  11.  menerima hasil .
    •  dapat melihat   Result.
    •  mengirimkan  kepada .
  12.  menerima  dan memeriksa  .
  13.  menerima   dari .
  14.  menerima response  dari .
  15.  memperbaharui  ke dalam database.
  16.  mengirimkan konfirmasi kepada .



Transaction Registration



Registration API Specifications

API Endpoint

/nicepay/api/orderRegist.do

Request Method

application/x-www-form-urlencoded

POST

Description

Perform Transaction Registration

Merchant Token

SHA256 (iMid+referenceNo+amt+merchantKey)

Payment Methods

01 

02 

03 

04 

05 

08 

09  Card



Registration API Parameters

Sample API Request
Sample API Response


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

10

 ID

IONPAYTEST

merchantToken

Required

AN

255

 Token

6cfccfc0046773c1b589d8e98f...

payMethod

Required

N

2

01

currency

Required

A

3

Currency

IDR

amt

Required

N

12

Transaction Amount

10000

cartData

Required

JSON String

4000

Transaction Cart Data

cardData



JSON

referenceNo

Required

ANS

40

 Order Number

MerchantReferenceNumber1

goodsNm

Required

AN

100

Goods Name

 Goods 1

callBackUrl

Required

ANS

255

 Result Page URL

https://merchant.com/callBackUrl

dbProcessUrl

Required

ANS

255

Push Notification URL

https://merchant.com/dbProcessUrl

userIP

Required

AN

15

User IP Address

127.0.0.1

description

Required

AN

100

Transaction Description

this is test order

billingNm

Required

A

30

Billing Name

Buyer Name

billingPhone

Required

N

15

Billing Phone Number

2123456789

billingEmail

Required

ANS

40

Billing E-Mail

buyer@merchant.com

billingCity

Required

A

50

Billing City

Jakarta Utara

billingState

Required

A

50

Billing State

DKI Jakarta

billingPostCd

Required

A

10

Billing Postal Code

10160

billingCountry

Required

A

10

Billing Country



billingAddr

AN

100

Billing Address

Billing Address

merFixAcctId

Required for Fix-Type VA

N

40

 Fix VA Number

14015824

instmntType

Required for CC

N

2

1

instmntMon

Required for CC

N

2

Installment Month

1

deliveryNm

A

30

Delivery Name

Delivery Name

deliveryPhone

N

15

Delivery Phone Number

2123456789

deliveryAddr

AN

100

Delivery Address

Delivery Address

deliveryCity

A

50

Delivery City

Jakarta Utara

deliveryState

A

50

Delivery State

DKI Jakarta

deliveryPostCd

N

10

Delivery Postal Code

10160

deliveryCountry

A

10

Delivery Country



vat

N

12

 Number

0

fee

N

12

Service Fee

0

notaxAmt

N

12

Tax Free Amount

0

reqDt

N

8

Request Date

20180303

reqTm

N

6

Request Time

135959

reqDomain

ANS

100

Request Domain

merchant.com

reqServerIP

ANS

15

Request Server IP Address

127.0.0.1

reqClientVer

AN

50

Request Client Version

1

userSessionID

AN

100

User Session ID

userSessionID

userAgent

Required for CC

ANS

100

User Agent Information

Mozilla

userLanguage

ANS

2

User Language

en-US

worker

AN

10

Worker

worker

vacctValidDt

N

8

 Valid Date (YYYYMMDD)

20180404

vacctValidTm

N

6

 Valid Time (HH24MISS)

235959

paymentExpDt

N

8

 Expired Date (YYYYMMDD)

20180404

paymentExpTm

N

6

 Expired Time (HH24MISS)

235959

payValidDt

N

8

CVS Valid Date (YYYYMMDD)

20180404

payValidTm

N

6

CVS Valid Time (HH24MISS)

235959

mRefNo

N

18

 Reference Number

bankcd123456789

timeStamp

N

14

Timestamp (YYYYMMDDHH24MISS)

20180404165639

mitraCd

A

4

Mitra Code

ESHP

version

AN



Version

 Lite

shopId

Required for QRIS

AN

32

Shop IDs



Catatan untuk Jenius:

Mohon gunakan iMid: TNICECP041 dan payMethod: 04 kemudian hit  ke Staging environment untuk kebutuhan pengembangan.



Cart Data API V1

JSON


Parameter

Deskripsi

count

Total Cart Data Count

item



item -> img_url

Good's Image URL (50x50 size)

item -> goods_name

Good's Name

item -> goods_detail

Good's Description

item -> goods_amt

Good's Amount

Setelah  berhasil didaftarkan, jangan lupa untuk mengalihkan Klien  menuju   .



NICEPAY Secure Payment Page


Payment Page
Payment Page




Payment Method Selection

Halaman Memilih Metode Pembayaran
Halaman Memilih Metode Pembayaran


Ketika  menekan  Change, mereka dapat melihat  di atas dan mengganti   diinginkan.

Catatan untuk  ShopeePay:

Untuk user experience  lebih baik bagi , mohon berikan sebuah tanda peringatan agar  membuka dari perangkat ponsel.



Payment Method QRIS Option

QRIS Payment Option
QRIS Payment Option


Konfirmasi  setelah  membuka aplikasi  dan memindai kode QR. Kemudian  Process.  akan mengarahkan  ke   dengan callbackUrl untuk memberikan  .

QRIS Payment Process
QRIS Payment Process




Payment Method Jenius Option

QRIS Payment - Jenius
QRIS Payment - Jenius


Setelah  memilih Jenius dan klik  Process, masukkan Cashtag ID. Setelah melakukan konfirmasi ,  dapat dilanjutkan pada aplikasi Jenius.



Transaction Payment



Payment API Specifications

API Endpoint

/nicepay/api/orderInquiry.do

Request Method application/x-www-form-urlencoded

POST

Description

URL Redirect to   Page



Payment API Parameters

URL

https://www.nicepay.co.id/nicepay/api/orderInquiry.do?tXid=IONPAYTEST01201608291733081257&optDisplayCB=0&optDisplayBL=0

Sample API Request


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

tXid

Required

AN

30

Transaction ID

IONPAYTEST02201607291027025291

optDisplayCB

N

2

Display Change Button

show = 0 hide = 1

optDisplayBL

N

2

Display Back Link

show = 0 hide = 1

Untuk mencegah Klien mengganti , pasang optDisplayCB = 1.



Payment Response Parameters

Sample Response to callbackUrl with parameter


Catatan: Parameter  Response akan dikirimkan melalui callBackurl dengan URL String Query.

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

N

4

Result Code

0000

resultMsg

AN

255

Success

tXid

AN

30

 Transaction ID

IONPAYTEST 02201607291027025291



When success

referenceNo

ANS

40

 Order Number

OrdNo20160525000



When success

authNo

N

10

 Auth No.

123456



When success (CC)

amount

N

12

Amount

1000



When success

transDt

N

8

Transaction Date

20200303



When success

transTm

N

6

Transaction Time

135959



When success

description

AN

100

Transaction Description

{{paym}} of OrdNo20160525000



When success

bankVacctNo

N

20

 Number

123457891011



When success (VA)

bankCd

A

4

VA Bank Code

BMRI



When success (VA)



Recuring Token



Ketika  menandatangani kontrak sebagai  berkala,  memberikan sebuah recurringToken untuk response  .

API Endpoint

/nicepay/api/recurringToken.do

Request Method application/x-www-form-urlencoded

POST

Description

Request  One Time Use Transaction Token recurringToken.do is almost same onePassToken.do The difference is whether using card info or using recurringToken

Merchant Token

SHA256 (Merchant ID + Reference Number + Amount + Merchant Key)

Request Parameter For Token

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

amt

N

12

Amount

10000

referenceNo

AN

40

 Order Number

20220623095906

merchantToken

AN

255

 Amount

141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b

iMid

AN

10

 ID

BMRITEST01

recurringToken

AN

100

Recurring Token

d4ef98b26f917a697691807cf737251cc15ef570a01457d15211a4f06e38ae64

instmntType

AN

2



instmntMon

N

2

Installment Month

1

Response Parameter For Token

Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

N

4

Result Code

0000

resultMsg

AN

255

SUCCESS

cardToken

AN

64

One Time Use Transaction Token

c954f03ef83a363f94fa26bef6ec4d08fa7693590a735386fcce6e2ef1caae8a

paymentType

AN

1

1 : 3Ds

2 : KeyIn



Ketika callbackurl sudah diterima, kami merekomendasikan para  untuk melakukan verifikasi Status dengan menggunakan  Inquiry.