NICEPAY API V2 QRIS - API Checkout

QRIS - API Checkout

16min

About QRIS - API Checkout 
﻿
This 
﻿ uses by 
﻿ to requests a 
﻿ to 
﻿ 
﻿ for 
﻿ 
﻿ method using 
﻿ 
﻿.
﻿
Process Flow
﻿
QRIS Process Flow
﻿
Steps description:
The 
﻿ does 
﻿.
The 
﻿ sends data checkout to 
﻿.
The 
﻿ sends request checkout using 
﻿ Registration to 
﻿.
﻿
﻿ does 
﻿ registration 
﻿.
﻿
﻿ redirects 
﻿ to 
﻿ 
﻿ 
﻿.
﻿
﻿ displays 
﻿ 
﻿ to 
﻿ 
﻿.
The 
﻿ chooses 
﻿.
The 
﻿ scan QR and send 
﻿ 
﻿ result to 
﻿ 
﻿.
﻿
﻿ 
﻿ does 
﻿ 
﻿.
﻿
﻿ 
﻿ sends 
﻿ note 
﻿ result to 
﻿ 
﻿.
﻿
﻿ 
﻿ sends 
﻿ or 
﻿ message to 
﻿.
﻿
﻿ updates 
﻿ 
﻿.
﻿
﻿ sends dbProcessUrl 
﻿ to 
﻿.
﻿
﻿ receives 
﻿.
﻿
﻿ request 
﻿ inquiry to 
﻿.
﻿
﻿ receives 
﻿ request.
﻿
﻿ sends 
﻿ inquiry response to 
﻿.
﻿
﻿ receives final 
﻿.
﻿
﻿ sends result 
﻿ 
﻿ to 
﻿ 
﻿.
Before making an 
﻿ calls for Transaction Payment﻿, execute 
﻿ Transaction Registration first.
﻿
﻿NICEPAY Secure Payment Page
﻿
Secure Payment Page
﻿
The image above is a sample of 
﻿ 
﻿ procedures with 
﻿ 
﻿ method using 
﻿ 
﻿ Secure 
﻿ Page.
The 
﻿ can't go back to 
﻿ Secure 
﻿ 
﻿ after choosing 
﻿ 
﻿ 
﻿ because 
﻿ QR code 
﻿ has already been generated successfully and is ongoing.

If 
﻿ 
﻿ needs to be changed, 
﻿ 
﻿ must re-create 
﻿ 
﻿ starting from 
﻿ initial 
﻿.
QRIS - Secure Payment Page
﻿
After choosing 
﻿ 
﻿ method, 
﻿ QR code will appear on 
﻿ next 
﻿. The 
﻿ can scan 
﻿ code directly by following 
﻿ QRIS Payment Guide﻿ or download 
﻿ image firsthand through 
﻿ Download QR Image 
﻿.
If 
﻿ QR code hasn't been used on 
﻿ 
﻿ but has already expired, 
﻿ 
﻿ must repeat 
﻿ generated QR code 
﻿ by returning to 
﻿ 
﻿ 
﻿ first.
﻿
API Checkout Transaction Payment
﻿
API url
/nicepay/redirect/v2/payment
Request Method 
Redirect-GET
Header
Content-Type: application/Form-UrlEncoded
﻿
Request Parameters for Payment
﻿
The following are Request Parameter lists for 
﻿ 
﻿ 
﻿ on 
﻿ 
﻿.
Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
paymentURL  
﻿Required﻿
URL
14
﻿
﻿ URL
﻿
﻿https://www.nicepay.co.id/nicepay/redirect/v2/payment
tXid 
﻿Required﻿
AN
30
Transaction ID	
﻿
IONPAYTEST00202103191252519205
﻿
Response Parameters (CallbackUrl) - Payment
﻿

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	
(Key from 
﻿)
TESTTEST0300202008070951284276
﻿
When success
referenceNo
ANS
40
Order Number
ord20200807090809
﻿
When success
amount
N
12
Transaction Amount
1000
﻿
When success
transDt
N
8
Registration Date (YYYYMMDD)	
20200808
﻿
When success
transTm
N
6
Registration Time (HH24MISS)	
120000
﻿
When success
description
AN
100
Transaction Description	
This is Testing Transaction	
﻿
When success
authNo
N
10
Approval Number	
1234567890
﻿
When success – Only CC (Additional)
recurringToken
AN
255
Recurring Token
5b949971aea6d468bebef20fec7b067abde88e52a4520925cd28dfa840ce5abc	
﻿
When success – Only CC (Additional)
cardNo
ANS
20
Card Number with Masking	
420192**2327
﻿
When success – Only CC
acquBankCd
A
-
﻿Acquiring Bank Code﻿﻿
BMRI
﻿
When success – Only CC
issuBankCd
A
-
﻿Issuing Bank Code﻿﻿
OTHR
﻿
When success – Only CC
vat
N
12
﻿
﻿ Number
0
﻿
When success
, CC
fee
N
12
Service Fee	
0
﻿
When success
, CC
notaxAmt
N
12
Tax Free Amount	
0
﻿
When success
, CC
bankCd
A
4
﻿Bank Code﻿﻿
BMRI
mitraCd
A
4
﻿Mitra Code﻿﻿
OVOE
﻿
When success 
﻿, 
﻿, 
﻿﻿
bankVacctNo
N
20
VA Number	
447770956314286
﻿
When success – VA
payNo
N
20
﻿
﻿ number
9041071059504308
﻿
When success – CVS
currency
A
3
Currency
IDR
﻿
When success – 
﻿, 
﻿ 
goodsNm
AN
100
Goods name
Testing Transaction 
﻿ 
﻿
When success – 
﻿, 
﻿﻿
billingNm
A
100
Billing Name
IONPAY NETWORK TESTING
﻿
When success – 
﻿, 
﻿ 
payMethod
N
2
﻿Payment Method Code﻿﻿
03
﻿
When success – 
﻿, 
﻿﻿
Note: The response 
﻿ will be sent through callBackurl with Content-type: application/json and method: POST Parameter.
﻿
Sample Parameter for CallbackUrl API Checkout Payment
﻿
On 
﻿ 
﻿ in 
﻿, 
﻿ response from 
﻿ request that gets hit is 
﻿ Callback URL.
Url Request
https://www.nicepay.co.id/nicepay/redirect/v2/payment?tXid=IONPAYTEST00202103191252519205
https://www.nicepay.co.id/nicepay/redirect/v2/payment?tXid=IONPAYTEST00202103191252519205
﻿
﻿
CallBack Handling API Checkout Payment
﻿
When Your callback already received callbackUrl, we recommended 
﻿ 
﻿ to do 
﻿ 
﻿ verification using 
﻿ Status Inquiry - API Checkout﻿.
CallBack Handling is very important to minimize 
﻿ Fraud act, we highly recommend 
﻿ 
﻿ to do 
﻿ verification using callBack parameter.
Callback Handling Flow
﻿
Response CallBack
Url Callback
https://merchant.com/callback-nicepay?resultCd=0000&resultMsg=SUCCESS&tXid=IONPAYTEST00202212211103524783&referenceNo=ORDERKU345&payMethod=09&amt=12000&billingNm=John+Doe&authNo=150367&cardNo=62210082****0590&acquBankCd=ARTJ&issuBankCd=ARTJ&acquBankNm=Artajasa&issuBankNm=Artajasa
https://merchant.com/callback-nicepay?resultCd=0000&resultMsg=SUCCESS&tXid=IONPAYTEST00202212211103524783&referenceNo=ORDERKU345&payMethod=09&amt=12000&billingNm=John+Doe&authNo=150367&cardNo=62210082****0590&acquBankCd=ARTJ&issuBankCd=ARTJ&acquBankNm=Artajasa&issuBankNm=Artajasa
﻿
﻿

Bank Indonesia already release API Standard relate to the Payment listed on Peraturan Anggota Dewan Gubernur No 23/15/PADG/2021 about Standar Nasional Open Application Interface Pembayaran (SNAP) Implementation.

As the form of suppport and compliance to Bank Indonesia Rules, NICEPAY drives all Merchant to conduct the migration to API SNAP BI.

All Merchants aim to complete the API SNAP BI migration on June 2024.

API url	/nicepay/redirect/v2/payment
Request Method	Redirect-GET
Header	Content-Type: application/Form-UrlEncoded

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
paymentURL Required	URL	14	URL	https://www.nicepay.co.id/nicepay/redirect/v2/payment
tXid Required	AN	30	Transaction ID	IONPAYTEST00202103191252519205

QRIS - API Checkout

About QRIS - API Checkout

Process Flow

﻿NICEPAY Secure Payment Page

API Checkout Transaction Payment

Request Parameters for Payment

Response Parameters (CallbackUrl) - Payment

Sample Parameter for CallbackUrl API Checkout Payment

CallBack Handling API Checkout Payment

Welcome to NICEPAY DOCS

NICEPAY Secure Payment Page