Inquiry List API
List Inquiry API
Tentang List Inquiry API
API ini digunakan untuk mendapatkan daftar transaksi berdasarkan Merchant Seller ID msId.
API End Point | /nicepay/direct/v2/listInquiry |
|---|---|
Request Method application/json | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256 ( timeStamp + iMid + Merchant Key) |
Request Parameter for List Inquiry
Tipe | Tipe | Ukuran | Deskripsi | Contoh/ Catatan |
|---|---|---|---|---|
timeStamp Required | N | 14 | API Request Date | 20170708123456 |
msId Required | AN | 30 | Merchant Seller ID | 123 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | AN | 40 | 05 | |
fromDt Required | N | 8 | Query Start Date | 20191201 |
toDt Required | N | 8 | Query End Date | 20191231 |
merchantToken Required | AN | 64 | Merchant Token | 46a8219f2e5a903252bb173608ca4324cb25b964d0208625a2ea5 79b385d264a |
Response Parameter for List Inquiry
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST05201912022223379276 |
referenceNo | ANS | 40 | Merchant Order Number | ord20191202221283 |
amt | N | 12 | Amount | 11000 |
fee | N | 12 | Fee | |
reqDt | N | 8 | Transaction Request Date (YYYYMMDD) | 20160301 |
reqTm | N | 6 | Transaction Request Time (HH24MISS) | 135959 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20160303 |
transTm | N | 6 | Transaction Time (HH24MISS) | 135959 |
goodsNm | AN | 100 | Goods Name | Test Transaction |
billingNm | A | 100 | Billing Name | Customer Name |
status | N | 1 | Transaction Status 0: Approved 3: Request 4: Cancel 8: Timeout 9: Failed 5: Reject before Approved | |
Sample JSON for List Inquiry API
{
"timeStamp": "20200306160251",
"msId": "123",
"iMid": "IONPAYTEST",
"payMethod": "05",
"fromDt": "20191201",
"toDt": "20191231",
"merchantToken": ""
}
Inquiry Detail API
Tentang Inquiry Detail API
API ini digunakan untuk memeriksa status kumpulan pesanan.
API End Point | /nicepay/direct/v2/InquiryDetail |
|---|---|
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256 (timeStamp + iMid + referenceNo+ amt + merchantKey) |
Request Parameter for Inquiry Detail
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
timeStamp Required | N | 14 | API Request Date | 20180810152800 |
tXid Required | AN | 30 | Transaction ID | BMRITEST0101201808101526233736 |
iMid Required | AN | 10 | Merchant ID | BMRITEST01 |
referenceNo Required | ANS | 40 | Merchant Order Number | OrdNo2018715255268 |
amt Required | N | 12 | Transaction Amount | 1000 |
merchantToken Required | AN | 255 | Merchant Token | 5a859cf700880565ef7f69218c0efce5bd601766d7bb479e2302f74fdeb95c74 |
Response Parameter for Inquiry Detail
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
count | N | 12 | Transaction Count | 3 |
transactions | AOO | | Transaction List | JSON Array |
acquirerData | Array | 20 | A dynamic array consisting of a unique reference number RRN that is provided by the Banking Partner when a refund is processed. This reference number can be used by the Customer to track the status of the refund with the Bank. | "acquirerData": { "rrn": "2399849" } |
Sample JSON for Inquiry Detail API
{
"count": 3,
"transactions": [
{
"tXid": "BMRITEST0101201808101526233736",
"iMid": "BMRITEST01",
"currency": "IDR",
"amt": "1000",
"instmntMon": "1",
"instmntType": "1",
"referenceNo": "OrdNo2018715255268",
"goodsNm": null,
"payMethod": "01",
"billingNm": "HongGilDong",
"billingPhone": "021-579-00000",
"billingEmail": "[email protected]",
"billingAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"billingCity": "Jakarta",
"billingState": "Jakarta",
"billingPostCd": "12950",
"billingCountry": "ID",
"deliveryNm": "HongGilDong",
"deliveryPhone": "62-21-0000-0000",
"deliveryAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"deliveryCity": "Jakarta",
"deliveryState": "Jakarta",
"deliveryPostCd": "12950",
"deliveryCountry": "ID",
"vat": null,
"fee": null,
"notaxAmt": null,
"description": null,
"merchantToken": null,
"reqDt": "20180810",
"reqTm": "152623",
"resultCd": "0000",
"resultMsg": "paid",
"merFixAcctId": null,
"vacctValidDt": null,
"vacctValidTm": null,
"status": "0",
"vacctNo": null,
"bankCd": "BMRI",
"cardNo": "483574******9802",
"depositAmt": null,
"issuBankCd": "HSBC",
"preauthToken": null,
"mitraCd": null,
"payNo": null,
"receiptCode": "009942",
"cancelAmt": null,
"transDt": "20180810",
"transTm": "152726",
"recurringToken": "58412707a41c69e3142a3ce1d99a09afbf0b8bcd9513f1726e09aabe2e5a3ddd",
"ccTransType": "1",
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": "00",
"cardExpYymm": "2110",
"issuBankNm": "HSBC",
"acquBankNm": "Mandiri",
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null,
"partialFlag": null,
"cancelReferenceNo": null,
"eciValue": "05",
"acquirerData": {
"rrn": "332608321717"
}
},
{
"tXid": "BMRITEST0101201808101527134133",
"iMid": "BMRITEST01",
"currency": "IDR",
"amt": "1000",
"instmntMon": "1",
"instmntType": "1",
"referenceNo": null,
"goodsNm": "T-1000",
"payMethod": "01",
"billingNm": "HongGilDong",
"billingPhone": "021-579-00000",
"billingEmail": "[email protected]",
"billingAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"billingCity": "Jakarta",
"billingState": "Jakarta",
"billingPostCd": "12950",
"billingCountry": "ID",
"deliveryNm": "HongGilDong",
"deliveryPhone": "62-21-0000-0000",
"deliveryAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"deliveryCity": "Jakarta",
"deliveryState": "Jakarta",
"deliveryPostCd": "12950",
"deliveryCountry": "ID",
"vat": null,
"fee": null,
"notaxAmt": null,
"description": null,
"merchantToken": null,
"reqDt": "20180810",
"reqTm": "152713",
"resultCd": "0000",
"resultMsg": "void",
"merFixAcctId": null,
"vacctValidDt": null,
"vacctValidTm": null,
"status": "1",
"vacctNo": null,
"bankCd": null,
"cardNo": null,
"depositAmt": null,
"issuBankCd": null,
"preauthToken": null,
"mitraCd": null,
"payNo": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": "20180810",
"transTm": "153805",
"recurringToken": null,
"ccTransType": null,
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": null,
"cardExpYymm": null,
"issuBankNm": "HSBC",
"acquBankNm": "Mandiri",
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null,
"partialFlag": null,
"cancelReferenceNo": null,
"eciValue": null,
"acquirerData": {
"rrn": "332608321717"
}
},
{
"tXid": "BMRITEST0101201808101538058789",
"iMid": "BMRITEST01",
"currency": "IDR",
"amt": "1000",
"instmntMon": "1",
"instmntType": "1",
"referenceNo": null,
"goodsNm": "T-1000",
"payMethod": "01",
"billingNm": "HongGilDong",
"billingPhone": "021-579-00000",
"billingEmail": "[email protected]",
"billingAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"billingCity": "Jakarta",
"billingState": "Jakarta",
"billingPostCd": "12950",
"billingCountry": "ID",
"deliveryNm": "HongGilDong",
"deliveryPhone": "62-21-0000-0000",
"deliveryAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"deliveryCity": "Jakarta",
"deliveryState": "Jakarta",
"deliveryPostCd": "12950",
"deliveryCountry": "ID",
"vat": null,
"fee": null,
"notaxAmt": null,
"description": null,
"merchantToken": null,
"reqDt": "20180810",
"reqTm": "153805",
"resultCd": "0000",
"resultMsg": "void",
"merFixAcctId": null,
"vacctValidDt": null,
"vacctValidTm": null,
"status": "1",
"vacctNo": null,
"bankCd": null,
"cardNo": null,
"depositAmt": null,
"issuBankCd": null,
"preauthToken": null,
"mitraCd": null,
"payNo": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": "20180810",
"transTm": "153805",
"recurringToken": null,
"ccTransType": null,
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": null,
"cardExpYymm": null,
"issuBankNm": "HSBC",
"acquBankNm": "Mandiri",
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null,
"partialFlag": "0",
"cancelReferenceNo": null,
"eciValue": null,
"acquirerData": {
"rrn": "332608321717"
}
}
]
}
Transaction List
Parameter for Transaction List
Parameter | Tipe | Ukuran | Dekripsi | Contoh / Catatan |
|---|---|---|---|---|
resultCd | N | 4 | 000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID (Key from NICEPAY) | BMRITEST0101201808101526233736 |
iMid | AN | 10 | Merchant ID | BMRITEST01 |
referenceNo | ANS | 40 | Merchant Order Number (Key from Merchant) | OrdNo2018715255268 |
payMethod | N | 2 | 01: Credit Card | |
amt | N | 12 | Payment Amount | 1000 |
currency | AN | 3 | Currency | IDR |
reqDt | N | 8 | Transaction Request Date (YYYYMMDD) | 20160301 |
reqTm | N | 6 | Transaction Request Time (HH24MISS) | 135959 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20160303 |
transTm | N | 6 | Transaction Time (HH24MISS) | 135959 |
goodsNm | AN | 100 | Goods Name | Merchant Goods 1 |
billingNm | AN | 100 | Buyer name | HongGilDong |
billingPhone | N | 15 | Buyer Phone | 021-579-00000 |
billingEmail | ANS | 40 | Buyer E-mail | |
billingAddr | ANS | 100 | Buyer Address | Jalan Jenderal Gatot Subroto Kav.57 |
billingCity | A | 50 | Buyer City | Jakarta |
billingState | A | 50 | Billing State | Jakarta |
billingPostCd | N | 10 | Billing Post Number | 12950 |
billingCountry | A | 10 | Billing Country | ID |
deliveryNm | A | 30 | Delivery Name | HongGilDong |
deliveryPhone | N | 15 | Delivery Phone | 62-21-0000-0000 |
deliveryAddr | AN | 100 | Delivery Address | Jalan Jenderal Gatot Subroto Kav.57 |
deliveryCity | A | 50 | Delivery City | Jakarta |
deliveryState | A | 50 | Delivery State | Jakarta |
deliveryPostCd | N | 10 | Delivery Post Code | 12950 |
deliveryCountry | A | 10 | Delivery Country | ID |
bankCd | AN | 4 | BMRI | |
status | N | 1 | Transaction Status 0: Paid 1: Void 2: Refund 3: Unpaid 4: Expired (VA, CVS, Direct Debit-Cancel) 8: Fail (Refer Status Code) | 0 |
eciValue | N | 2 | Card ECI | 05 |
issuBankCd | A | 4 | BMRI | |
acquBankCd | A | 4 | BMRI | |
cardNo | AN | 20 | Card Number with Masking | 483574**9802 |
cardExpYymm | N | 4 | Card Expiry (YYMM) | 2110 |
instmntMon | N | 2 | Installment Month | 1 |
instmntType | N | 2 | 1 | |
preauthToken | AN | 255 | Pre-Auth Token (Need for Capture for PREAUTH Only) | Ty23revc85452geg46hw33aaca6d17a33e4ad72cfc7c4c656hjt4 |
recurringToken | AN | 255 | Recurring Token (Can Use Next Payment for RECURRING Only) | 412707a41c69e3142a3ce1d99a09afbf0b8bcd9513f1726e09aabe2e5a3ddd |
receiptCode | N | 6 | Receipt Code | null |
ccTransType | AN | 2 | 1 | |
acquStatus | AN | 2 | Purchase Status 00: Not Purchase 01: Later Cancel Not Purchase 10: Finish Purchase 99: etc | 00 |
vat | N | 12 | Vat | null |
fee | N | 12 | Service Fee | null |
notaxAmt | N | 12 | Tax Free Amount | null |
depositDt | N | 8 | Transaction Request Date (YYYYMMDD) | null |
depositTm | N | 6 | Transaction Request Time (HH24MISS) | null |
depositAmt | N | 20 | Deposit Amount | null |
paymentExpDt | N | 6 | Payment Expiry Date (YYYYMMDD) | null |
paymentExpTm | N | 6 | Payment Expiry Time (HH24MISS) | null |
paymentTrxSn | N | 32 | Payment Expiry Date (YYYYMMDD) | null |
cancelTrxSn | AN | 32 | Cancel Transaction Number | null |
cancelAmt | N | 12 | Cancel Amount | null |
userId | AN | 128 | User ID Hash | null |
shopId | AN | 32 | Shop ID | null |
partialFlag | A | 4 | Partial Flagging | null |
cancelReferenceNo | ANS | 40 | Cancel Reference Number | null |
mitraCd | A | 4 | Mitra Code | null |
mRefNo | AN | 20 | Bank Reference Number | null |
Sample JSON Array for Transaction List
{
"count": 3,
"transactions": [
{
"tXid": "BMRITEST0101201808101526233736",
"iMid": "BMRITEST01",
"currency": "IDR",
"amt": "1000",
"instmntMon": "1",
"instmntType": "1",
"referenceNo": "OrdNo2018715255268",
"goodsNm": null,
"payMethod": "01",
"billingNm": "HongGilDong",
"billingPhone": "021-579-00000",
"billingEmail": "[email protected]",
"billingAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"billingCity": "Jakarta",
"billingState": "Jakarta",
"billingPostCd": "12950",
"billingCountry": "ID",
"deliveryNm": "HongGilDong",
"deliveryPhone": "62-21-0000-0000",
"deliveryAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"deliveryCity": "Jakarta",
"deliveryState": "Jakarta",
"deliveryPostCd": "12950",
"deliveryCountry": "ID",
"vat": null,
"fee": null,
"notaxAmt": null,
"description": null,
"merchantToken": null,
"reqDt": "20180810",
"reqTm": "152623",
"resultCd": "0000",
"resultMsg": "paid",
"merFixAcctId": null,
"vacctValidDt": null,
"vacctValidTm": null,
"status": "0",
"vacctNo": null,
"bankCd": "BMRI",
"cardNo": "483574******9802",
"depositAmt": null,
"issuBankCd": "HSBC",
"preauthToken": null,
"mitraCd": null,
"payNo": null,
"receiptCode": "009942",
"cancelAmt": null,
"transDt": "20180810",
"transTm": "152726",
"recurringToken": "412707a41c69e3142a3ce1d99a09afbf0b8bcd9513f1726e09aabe2e5a3ddd",
"ccTransType": "1",
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": "00",
"cardExpYymm": "2110",
"issuBankNm": "HSBC",
"acquBankNm": "Mandiri",
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null,
"partialFlag": null,
"cancelReferenceNo": null,
"eciValue": "05"
},
{
"tXid": "BMRITEST0101201808101527134133",
"iMid": "BMRITEST01",
"currency": "IDR",
"amt": "1000",
"instmntMon": "1",
"instmntType": "1",
"referenceNo": null,
"goodsNm": "T-1000",
"payMethod": "01",
"billingNm": "HongGilDong",
"billingPhone": "021-579-00000",
"billingEmail": "[email protected]",
"billingAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"billingCity": "Jakarta",
"billingState": "Jakarta",
"billingPostCd": "12950",
"billingCountry": "ID",
"deliveryNm": "HongGilDong",
"deliveryPhone": "62-21-0000-0000",
"deliveryAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"deliveryCity": "Jakarta",
"deliveryState": "Jakarta",
"deliveryPostCd": "12950",
"deliveryCountry": "ID",
"vat": null,
"fee": null,
"notaxAmt": null,
"description": null,
"merchantToken": null,
"reqDt": "20180810",
"reqTm": "152713",
"resultCd": "0000",
"resultMsg": "void",
"merFixAcctId": null,
"vacctValidDt": null,
"vacctValidTm": null,
"status": "1",
"vacctNo": null,
"bankCd": null,
"cardNo": null,
"depositAmt": null,
"issuBankCd": null,
"preauthToken": null,
"mitraCd": null,
"payNo": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": "20180810",
"transTm": "153805",
"recurringToken": null,
"ccTransType": null,
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": null,
"cardExpYymm": null,
"issuBankNm": "HSBC",
"acquBankNm": "Mandiri",
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null,
"partialFlag": null,
"cancelReferenceNo": null,
"eciValue": null
},
{
"tXid": "BMRITEST0101201808101538058789",
"iMid": "BMRITEST01",
"currency": "IDR",
"amt": "1000",
"instmntMon": "1",
"instmntType": "1",
"referenceNo": null,
"goodsNm": "T-1000",
"payMethod": "01",
"billingNm": "HongGilDong",
"billingPhone": "021-579-00000",
"billingEmail": "[email protected]",
"billingAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"billingCity": "Jakarta",
"billingState": "Jakarta",
"billingPostCd": "12950",
"billingCountry": "ID",
"deliveryNm": "HongGilDong",
"deliveryPhone": "62-21-0000-0000",
"deliveryAddr": "Jalan Jenderal Gatot Subroto Kav.57",
"deliveryCity": "Jakarta",
"deliveryState": "Jakarta",
"deliveryPostCd": "12950",
"deliveryCountry": "ID",
"vat": null,
"fee": null,
"notaxAmt": null,
"description": null,
"merchantToken": null,
"reqDt": "20180810",
"reqTm": "153805",
"resultCd": "0000",
"resultMsg": "void",
"merFixAcctId": null,
"vacctValidDt": null,
"vacctValidTm": null,
"status": "1",
"vacctNo": null,
"bankCd": null,
"cardNo": null,
"depositAmt": null,
"issuBankCd": null,
"preauthToken": null,
"mitraCd": null,
"payNo": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": "20180810",
"transTm": "153805",
"recurringToken": null,
"ccTransType": null,
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": null,
"cardExpYymm": null,
"issuBankNm": "HSBC",
"acquBankNm": "Mandiri",
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null,
"partialFlag": "0",
"cancelReferenceNo": null,
"eciValue": null
}
]
}