Check Status Transaction API QRIS SNAP NICEPAY

Check Status Transaction - API QRIS SNAP

7min

Tentang Check Status Transaction - API QRIS SNAP
﻿
API dengan standar SNAP ini digunakan untuk memeriksa status transaksi pembayaran pada metode pembayaran QRIS.
﻿
Check Status Transaction - API QRIS SNAP
﻿
Silakan mengajukan akses token terlebih dahulu sebelum melakukan pemeriksaan status transaksi (Check Status Transaction API) melalui bagian Request Access Token API - SNAP﻿.
Service Code
47
API Endpoint
/nicepay/api/v1.0/qr/qr-mpm-query
HTTP Method
POST
Description
Check Status Transaction API
Content-type
application/json
﻿
Request Check Status Header Parameter
Nama Parameter Header
Tipe
Kebutuhan
Deskripsi
Contoh
Content-Type
String (127)
Mandatory
Type of the content
Application/Json
X-TIMESTAMP
String 
(25)
Mandatory
Using ISO 8601 as timestamp format.
Transaction date time, in format YYYYMMDDTHH:mm:ss+07:00.
Time must be in GMT+7 (Jakarta time).
2022-03-21T10:11:40+07:00.
﻿
Authorization
String (Variable)
Mandatory
"Bearer" + {access_token}
﻿
X-SIGNATURE
String (Variable)
Mandatory
Generated by Partner / Merchant SHA256withRSA (Private_Key, stringToSign).
﻿
stringToSign = client_ID + "|" + X-TIMESTAMP
﻿
X-PARTNER-ID
String(20)
Mandatory
NICEPAY Client ID (MID)
IONPAYTEST
X-EXTERNAL-ID
String (40)
Mandatory
Unique messaging Reference ID generated by Merchant. Numeric String. Reference number that should be unique in every transaction in One Day.
﻿
CHANNEL-ID
String (5)
Mandatory
Device identification on which the API services is currently being accessed by the End User (Customer)
﻿
﻿
Request Check Status Body Parameter
Nama Parameter BI
Tipe Parameter
Kebutuhan
Parameter NICEPAY
Deskripsi 
Contoh
originalReferenceNo
String 
(40)
Mandatory
tXid
NICEPAY Transaction ID or Identifier
IONPAYTEST08202106091121206416
originalPartnerReferenceNo
String 
(40)
Mandatory
referenceNo
Unique Transaction ID from Merchant
ncpy20221017161458
merchantId
String 
(10)
Mandatory
iMid
NICEPAY Merchant ID
IONPAYTEST
externalStoreId
String 
(32)
Mandatory
storeCd
Merchant ID from Acquirer Pay Side
NICEPAY
serviceCode
String 
(2)
Mandatory
-
Transaction Type Indicator (service code of the original transaction request)
47
additionalInfo
Object
Mandatory
-
 
"additionalInfo": {
  }
﻿
Response Check Status Parameter
Nama Parameter BI
Tipe Parameter
Kebutuhan
Parameter NICEPAY
Deskripsi
Contoh
responseCode
String (7)
Mandatory
responseCd
Error Code to Specify the Error Returned
﻿General Response Code and Message - API SNAP﻿﻿
2005100
responseMessage
String (150)
Mandatory
responseMsg
Debug Message to Provide More Information
Successful
originalReferenceNo
String (40)
Mandatory
tXid
NICEPAY Transaction ID or Identifier
IONPAYTEST08202106091121206416
originalPartnerReferenceNo
String (40)
Mandatory
referenceNo
Unique Transaction ID from Merchant
ncpy20221017161458
serviceCode
String (2)
Mandatory
-
Transaction Type Indicator (Service Code of the Original Transaction Request)
47
latestTransactionStatus
String (2)
Mandatory
status
﻿Status of the Transaction﻿﻿
00
paidTime
String (25)
Mandatory
transDt, transTm
Transaction Date Using ISO-8601 Format
YYYY-MM-DDTHH:MM:SS
2022-07-20T07:15:00+07:00
amount
Object
Mandatory
"amount": {
    ...
  }
-
﻿
 - value
String (12)
Mandatory
amt
Transaction Amount

Note: Amount Format, Currently Only Supported IDR (Indonesian Currency Rupiah) then Value Includes 2 Decimal Digits which are Separated by a Dot (.)
10000.00
 - currency
String (3)
Mandatory
Currency
Default Value: IDR
IDR
additionalInfo
Object
Mandatory
"additionalInfo": {
    ...
  }
﻿
﻿
 - merchantId
String (10)
Mandatory
iMid
NICEPAY Merchant ID
IONPAYTEST
 - paymentTrxSn
String (32)
Mandatory
paymentTrxSn
Payment Transaction Number from Acquirer Side
07202210051341224326
 - cancelTrxSn
String (32)
Conditional
cancelTrxSn
Cancel Transaction Number from Acquirer Side if Payment has been Cancelled
07202210051341224326
 - cancelAmt
String (12)
Conditional
﻿
Transaction Amount

Note: Amount Format, Currently Only Supported IDR (Indonesian Currency Rupiah) then Value includes 2 Decimal Digits which are Separated by a Dot (.)
10000.00
 - requestTime
String (25)
Mandatory
reqDt,
reqTm
Transaction Date Using ISO-8601 Format
YYYY-MM-DDTHH:MM:SS
2022-07-20T07:15:00+07:00
 - goodsNm
String (200)
Mandatory
﻿
Goods Name
Merchant Goods 1
 - billingNm
String (100)
Mandatory
﻿
Buyer Name
Buyer Name
 - userId
String (128)
Mandatory
userId
QRIS User ID
213naUASIQBIH341bdjashf1204gkjbcasc
 - externalStoreId
String (32)
Mandatory
storeCd
Merchant ID from Acquirer Pay Side
NICEPAY
﻿
Sample Parameter
Sample Request
Sample Response
{
    "responseCode": "2005100",
    "responseMessage": "Successful",
    "originalReferenceNo": "TNICEQR08108202404181012168473",
    "originalPartnerReferenceNo": "ordNo2022120215134035",
    "serviceCode": "47",
    "latestTransactionStatus": "00",
    "paidTime": "2024-04-18T10:14:07+07:00",
    "amount": {
        "value": "100.00",
        "currency": "IDR"
    },
    "additionalInfo": {
        "goodsNm": "Test SNAP Transaction Nicepay",
        "billingNm": "John Doe",
        "merchantId": "TNICEQR081",
        "paymentTrxSn": "101378968850945616",
        "cancelTrxSn": "",
        "userId": "101378968850945616",
        "externalStoreId": "NicepayStoreID1",
        "requestTime": "2024-04-18T10:12:16+07:00"
    }
}

{
    "responseCode": "2005100",
    "responseMessage": "Successful",
    "originalReferenceNo": "TNICEQR08108202404181012168473",
    "originalPartnerReferenceNo": "ordNo2022120215134035",
    "serviceCode": "47",
    "latestTransactionStatus": "00",
    "paidTime": "2024-04-18T10:14:07+07:00",
    "amount": {
        "value": "100.00",
        "currency": "IDR"
    },
    "additionalInfo": {
        "goodsNm": "Test SNAP Transaction Nicepay",
        "billingNm": "John Doe",
        "merchantId": "TNICEQR081",
        "paymentTrxSn": "101378968850945616",
        "cancelTrxSn": "",
        "userId": "101378968850945616",
        "externalStoreId": "NicepayStoreID1",
        "requestTime": "2024-04-18T10:12:16+07:00"
    }
}
﻿
﻿

Bank Indonesia telah menerbitkan Standar API terkait Pembayaran yang tercantum dalam Peraturan Anggota Dewan Gubernur No 23/15/PADG/2021 tentang Implementasi Standar Nasional Open Application Interface Pembayaran (SNAP).

Sebagai bentuk dukungan dan kepatuhan terhadap Peraturan Bank Indonesia, NICEPAY mendorong seluruh merchant untuk melakukan migrasi ke API SNAP BI.

Seluruh Merchant ditargetkan untuk dapat menyelesaikan migrasi API SNAP BI pada Juni 2024.

Service Code	47
API Endpoint	/nicepay/api/v1.0/qr/qr-mpm-query
HTTP Method	POST
Description	Check Status Transaction API
Content-type	application/json

Nama Parameter Header	Tipe	Kebutuhan	Deskripsi	Contoh
Content-Type	String (127)	Mandatory	Type of the content	Application/Json
X-TIMESTAMP	String (25)	Mandatory	Using ISO 8601 as timestamp format. Transaction date time, in format YYYYMMDDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time). 2022-03-21T10:11:40+07:00.
Authorization	String (Variable)	Mandatory	"Bearer" + {access_token}
X-SIGNATURE	String (Variable)	Mandatory	Generated by Partner / Merchant SHA256withRSA (Private_Key, stringToSign). stringToSign = client_ID + "\|" + X-TIMESTAMP
X-PARTNER-ID	String(20)	Mandatory	NICEPAY Client ID (MID)	IONPAYTEST
X-EXTERNAL-ID	String (40)	Mandatory	Unique messaging Reference ID generated by Merchant. Numeric String. Reference number that should be unique in every transaction in One Day.
CHANNEL-ID	String (5)	Mandatory	Device identification on which the API services is currently being accessed by the End User (Customer)

Nama Parameter BI	Tipe Parameter	Kebutuhan	Parameter NICEPAY	Deskripsi	Contoh
originalReferenceNo	String (40)	Mandatory	tXid	NICEPAY Transaction ID or Identifier	IONPAYTEST08202106091121206416
originalPartnerReferenceNo	String (40)	Mandatory	referenceNo	Unique Transaction ID from Merchant	ncpy20221017161458
merchantId	String (10)	Mandatory	iMid	NICEPAY Merchant ID	IONPAYTEST
externalStoreId	String (32)	Mandatory	storeCd	Merchant ID from Acquirer Pay Side	NICEPAY
serviceCode	String (2)	Mandatory	-	Transaction Type Indicator (service code of the original transaction request)	47
additionalInfo	Object	Mandatory	-		"additionalInfo": { }

Check Status Transaction - API QRIS SNAP

Tentang Check Status Transaction - API QRIS SNAP

Check Status Transaction - API QRIS SNAP

Request Check Status Header Parameter

Request Check Status Body Parameter

Response Check Status Parameter

Sample Parameter

Selamat Datang di NICEPAY DOCS