Check Status Transaction - API QRIS SNAP
About Check Status Transaction - API QRIS SNAP
This API with SNAP standards uses to check the payment transaction status on the QRIS payment method.
Check Status Transaction - API QRIS SNAP
Please request the access token firsthand before executing the Check Status Transaction API through the Request Access Token API - SNAP section.
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 Header Parameter for Check Status Transaction - API QRIS SNAP
Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
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 | Signature will be generated by Merchant. | |
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 | Unique Channel Merchant Credential ID Number. Client ID + "01" = Channel ID "IONPAYTEST" + "01" = "IONPAYTEST01" | IONPAYTEST01 |
Request Body Parameter for Check Status Transaction - API QRIS SNAP
Parameter | Parameter Type | Mandatory | NICEPAY Parameter | Description or Example | Example |
|---|---|---|---|---|---|
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 | - | - | {} |
Response Parameter for Check Status Transaction - API QRIS SNAP
Parameter | Parameter Type | Mandatory | NICEPAY Parameter | Description | Example |
|---|---|---|---|---|---|
responseCode | String (7) | Mandatory | responseCd | Error code to specify the error returned | 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) | 51 |
latestTransactionStatus | String (2) | Mandatory | status | 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 seperated 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 seperated 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 for Check Status Transaction - API QRIS SNAP
Request Parameter
// This configuration should be initialized with your actual credentials
const config = {
isProduction: false,
privateKey: "YOUR_PRIVATE_KEY", // Replace with your actual private key
clientSecret: "YOUR_CLIENT_SECRET", // Replace with your actual client secret
clientId: "TNICEQR081",
isCloudServer: false,
};
const accessToken = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJUTklDRVFSMDgxIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJOSUNFUEFZIiwiZXhwIjoiMjAyNC0wNC0xOFQwNTowMzo1NloifQ==.IN_MYPmwhWgxRYWnTBZ7RDgG6-UqjZSLfUx9Ayn37Ek=";
let paramQuery = {
body: {
originalReferenceNo:"TNICEQR08108202404181012168473",
originalPartnerReferenceNo:"ordNo2022120215134035",
merchantId:"TNICEQR081",
externalStoreId:"NicepayStoreID1",
serviceCode:"47",
additionalInfo:{}
},
headers: {
X_EXTERNAL_ID: "11044820240418",
CHANNEL_ID: "TNICEQR08101",
},
};
let snap = new Snap(config);
let endPoint = `/api/v1.0/qr/qr-mpm-query`;
let response = snap
.requestSnapTransaction(paramQuery, endPoint, accessToken, "POST");
Response Parameter
{
"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"
}
}