NICEPAY API
...
API Versi 1
V1 Enterprise

QRIS - V1 Enterprise

8min

Tentang QRIS



NICEPAY menyediakan layanan baru dalam metode pembayaran QRIS dari kerja sama dengan ShopeePay. Dengan menggunakan metode ini, Pelanggan akan memiliki pilihan untuk melakukan pembayaran melalui E-Wallet (ShopeePay, OVO, GoPay, dan DANA). Notifikasi real-time akan dikirimkan setelah Pelanggan menyelesaikan pembayaran.

Harap background kode QR menggunakan warna putih agar mudah dipindai.

QRIS Flow V1:

  1. Merchant melakukan request ke API Register NICEPAY.
  2. Merchant menampilkan QR Code and memberitahukan langkah pembayaran ke Pelanggan.
  3. Pelanggan akan scan QR, dan melakukan autentikasi untuk pembayaran.
  4. NICEPAY akan memeriksa status pembayaran, lalu mengirimkan Notifikasi.
  5. Merchant mengolah notifikasi yang didapatkan.
QRIS Flow V1 Enterprise
QRIS Flow V1 Enterprise


Deskripsi langkah:

  1. Pelanggan melakukan checkout pesanan kepada Merchant.
  2. Merchant melakukan pendaftaran checkout melalui API Registration (/nicepay/api/onePass.do) kepada NICEPAY.
  3. NICEPAY mengajukan pembayaran pesanan kepada Mitra QRIS.
  4. Mitra QRIS melakukan generate kode QR.
  5. Mitra QRIS mengirimkan response QR kepada NICEPAY.
  6. NICEPAY mengirimkan response QR kepada Merchant.
  7. Merchant menampilkan QR kepada Pelanggan.
  8. Pelanggan memindai QR dan menginisiasi pembayaran kepada Mitra QRIS.
  9. Mitra QRIS menampilkan response pembayaran kepada Pelanggan.
  10. Mitra QRIS mengirimkan push notification kepada NICEPAY.
  11. NICEPAY melakukan validasi notifikasi.
  12. NICEPAY memeriksa status pembayaran kepada Mitra QRIS.
  13. Mitra QRIS mengirimkan response status pembayaran kepada NICEPAY.
  14. NICEPAY memperbaharui status.
  15. NICEPAY mengirimkan push notification kepada Merchant.
  16. Merchant mengajukan pemeriksaan status menggunakan Check Status API kepada NICEPAY.
  17. NICEPAY mengirimkan response pemeriksaan status kepada Merchant.
  18. Merchant menerima status akhir.
  19. Merchant mengirimkan konfirmasi update status kepada Pelanggan.



QRIS Registration



API Specifications - QRIS Registration

API Endpoint

/nicepay/api/onePass.do

Request Method application/x-www-form-urlencoded

POST

Description

QRIS Payment API

Merchant Token

SHA256(iMid+referenceNo+amt+merchantKey)

Payment Method

08 QRIS



Request Parameter - QRIS Registration

QRIS Registration - Request Parameter


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

10

Merchant ID

IONPAYTEST

payMethod Required 

N

2

08

currency Required 

A

3

Currency

IDR

amt Required 

N

12

Goods Amount

15000

referenceNo Required

ANS

40

Merchant Order Number

ordNo123124

goodsNm Required 

AN

100

Goods Name

Test Goods

billingNm Required 

A

A

Billing Name

John Doe

billingPhone Required 

N

15

Billing Phone Number

081249195

billingEmail Required 

ANS

40

Billing E-Mail

test@merchant.com

billingCity Required

A

50

Billing City

Jakarta

billingState Required 

A

50

Billing State

DKI Jakarta

billingPostCd Required 

N

10

Billing Post Number

14350

billingCountry Required 

A

10

Billing Country

Indonesia

callBackUrl Required 

ANS

255

Payment Result URL

https://merchant.com/callBackUrl

dbProcessUrl Required 

ANS

255

Payment Notif URL

https://merchant.com/dbProcessUrl

description Required 

AN

100

Description

test item

merchantToken Required 

AN

255

Merchant Token

6cfccfc0046773c1b589d8e 98f8b596c284f3c70a4ecf8 6eba14c18944b74bcd

userIP Required

ANS

15

User IP (Customer)

127.0.0.1

cartData Required

JSON OBJECT

4000

Cart Data (JSON Format)

{}

mitraCd Required

A

4

Mitra Code

QSHP

shopId

Required

AN

32

Shop ID

NICEPAY

billingAddr

AN

255

Billing Address

Jln Cendrawasih

deliveryNm

A

30

Delivery Name

John Doe

deliveryPhone

N

15

Delivery Phone

08125912342

deliveryAddr

AN

100

Delivery Address

Jln Merak

deliveryEmail

ANS

100

Delivery E-Mail

test@merchant.com

deliveryCity

A

50

Delivery City

Jakarta

deliveryState

A

50

Delivery State

DKI Jakarta

deliveryPostCd

A

10

Delivery Post Code

14350

deliveryCountry

A

10

Delivery Country

Indonesia

vat

N

12

VAT

0

fee

N

12

Service Tax

0

notaxAmt

N

12

Tax Free Amount

0

reqDt

N

8

Request Date (YYYYMMDD)

20160301

reqTm

N

6

Request Time (HH24MISS)

135959

reqDomain

ANS

100

Request Domain

merchant.com

reqServerIP

ANS

15

Request Server IP

127.0.0.1

reqClientVer

ANS

50

Request Client Version

1.0

userSessionID

AN

100

User Session ID

userSessionID

userAgent

ANS

100

User Agent

Mozilla

userLanguage

ANS

2

User Language

en-US



Registration Response - QRIS Registration

QRIS Registration - Response Parameter


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

N

4

Result Code

0000

resultMsg

AN

255

SUCCESS

tXid

AN

30

Transaction ID

IONPAYTEST08202104011206088687

referenceNo

ANS

40

Merchant Reference Number

ORDER2909

payMethod

N

2

08

amount

N

12

Payment Amount

1000

transDt

N

8

Transaction Date (YYYYMMDD)

20210401

transTm

N

6

Transaction Time (HH24MISS)

120609

description

ANS

100

Transaction Description

null

callbackUrl

ANS

100

Callback URL

https://merchant.com/api/callBackUrl

paymentExDt

N

6

QR Payment Expired Date (YYYYMMDD)

20210401

paymentExpTm

N

6

QR Payment Expired Time (HH24MISS)

121109

currency

A

3

Currency

IDR

goodsNm

AN

100

Goods Name

Merchant Goods 1

billingNm

N

30

Buyer Name

John Doe

qrContent

ANS

360

QR String in Plain Text

00020101021226580016ID.CO.SHOPEE.WWW01189360091800000169110205169110303UMI52041234530336054071000.005802ID5907NICEPAY6015KOTA JAKARTA PU61051234562360520082021040112060930000708T000000163041210

qrUrl

ANS

360

URL for QR Image, Valid for 5 Minutes

https://api.uat.wallet.airpay.co.id/v3/merchant-host/qr/download?qr=9d0DmD3uqAVzLMNWz05b1ExK3GAX7yY07x3wg4OYKK