Transaction History API
About Transaction History API
Transaction History API uses for status reconciliation and transaction amount with NICEPAY. Merchant gets list of transaction data up to 5,000 data for every request compatible with the needed date.
Transaction History API
API End Point | |
|---|---|
Request Method | POST |
Description | To check transaction history with NICEPAY via API |
Header | Content-Type: application/json |
Request Format | application/json |
Request Parameter
Parameter | Type | Length | Description | Example / Note |
|---|---|---|---|---|
mid Required | VARCHAR2 | 10 | iMid Merchant | IONPAYTEST |
passwd Required | VARCHAR2 | 100 | Password gain after Whitelist IP process successfully registered on NICEPAY side (Please contact NICEPAY Customer Service team for assistance) | 123456 |
transdt Required | VARCHAR2 | 8 | Transaction data date to be seen Format: YYYYMMDD | 20200101 |
startno Required | NUMBER | 10 | The beginning of the transaction data that will be seen | 1 Default: 1 |
endno Required | NUMBER | 10 | The last of the transaction data that will be seen, maximum 5,000 | 100 Default: 100 |
Response Parameter
Parameter | Type | Length | Description | Example / Note |
|---|---|---|---|---|
HEADER Required | Object | - | - | "HEADER": {...} |
CODE Required | NUMBER | 4 | 00 | |
MID Required | VARCHAR2 | 10 | iMid Merchant | IONPAYTEST |
TRANS_DT Required | VARCHAR2 | 8 | The requested transaction data date Format: YYYYMMDD | 20200101 |
DATA Required | Object | - | - | "DATA": [ { ... } ] |
CODE Required | NUMBER | 4 | 10 | |
TXID Required | VARCHAR2 | 30 | Transaction ID | IONPAYTEST01202001010010379759 |
ORDER_NO Required | NUMBER | 10 | Merchant Reference Number | 99999 |
TRANS_STATUS Required | NUMBER | 2 | Transaction Status: Transaction Status Code | 0 |
TRANS_DT Required | VARCHAR2 | 8 | The requested transaction data date Format: YYYYMMDD | 20200101 |
TRANS_TM Required | VARCHAR2 | 8 | Hour time from the requested transaction data Format: HHmmss | 001037 |
CANCEL_DT Required | VARCHAR2 | 8 | Transaction Cancellation Date Format: YYYYMMDD | - |
CANCEL_TM Required | VARCHAR2 | 8 | The cancellation transaction time Format: HHmmss | - |
PAY_METHOD Required | VARCHAR2 | 2 | 01 | |
TRANS_AMT Required | NUMBER | 19,2 | Transaction Amount | 10000 |
CUSTOMER_NO Required | VARCHAR2 | 40 | Customer Account Transaction Number | 123412**12341234 |
SETTLMNT_DT Required | VARCHAR2 | 8 | Settlement date, it will be shown directly if available | - |
TAIL Required | Object | - | - | "TAIL": { ... } |
CODE Required | NUMBER | 4 | 99 | |
MID Required | VARCHAR2 | 10 | iMid Merchant | IONPAYTEST |
TRANS_DT Required | VARCHAR2 | 8 | The requested transaction data date Format: YYYYMMDD | 20200101 |
APP_TRANS_CNT Required | NUMBER | 10 | The sum of total transaction volume | 6 |
APP_TRANS_AMT Required | NUMBER | 19,2 | The sum of total transaction amount | 290087 |
CC_TRANS_CNT Required | NUMBER | 10 | The sum of total transaction refund volume | 0 |
CC_TRANS_AMT Required | NUMBER | 19,2 | The sum of total amount transaction refund | 0 |
Sample Parameter
{
"HEADER": {
"CODE": "00",
"MID": "IONPAYTEST",
"TRANS_DT": "20200101"
},
"DATA": [
{
"CODE": "10",
"TXID": "IONPAYTEST01202001010010379759",
"ORDER_NO": "99999",
"TRANS_STATUS": "0",
"TRANS_DT": "20200101",
"TRANS_TM": "001037",
"CANCEL_DT": "-",
"CANCEL_TM": "-",
"PAY_METHOD": "01",
"TRANS_AMT": 10000,
"CUSTOMER_NO": "123412******12341234",
"SETTLMNT_DT": "-"
},
{
"CODE": "10",
"TXID": "IONPAYTEST01202001010015131172",
"ORDER_NO": "99999",
"TRANS_STATUS": "0",
"TRANS_DT": "20200101",
"TRANS_TM": "001513",
"CANCEL_DT": "-",
"CANCEL_TM": "-",
"PAY_METHOD": "01",
"TRANS_AMT": 10000,
"CUSTOMER_NO": "123412******12341234",
"SETTLMNT_DT": "-"
},
{
"CODE": "10",
"TXID": "IONPAYTEST01202001010950206003",
"ORDER_NO": "T2148P7ZU8GXADB",
"TRANS_STATUS": "0",
"TRANS_DT": "20200101",
"TRANS_TM": "095019",
"CANCEL_DT": "-",
"CANCEL_TM": "-",
"PAY_METHOD": "01",
"TRANS_AMT": 65018,
"CUSTOMER_NO": "111133******5555",
"SETTLMNT_DT": "-"
},
{
"CODE": "10",
"TXID": "IONPAYTEST01202001010950256020",
"ORDER_NO": "T210LX4NZ3F7N35",
"TRANS_STATUS": "0",
"TRANS_DT": "20200101",
"TRANS_TM": "095025",
"CANCEL_DT": "-",
"CANCEL_TM": "-",
"PAY_METHOD": "01",
"TRANS_AMT": 29018,
"CUSTOMER_NO": "111112******12222111",
"SETTLMNT_DT": "-"
},
{
"CODE": "10",
"TXID": "IONPAYTEST05202001011020342509",
"ORDER_NO": "T21FZF8IBZAE1OM",
"TRANS_STATUS": "0",
"TRANS_DT": "20200101",
"TRANS_TM": "102034",
"CANCEL_DT": "-",
"CANCEL_theTM": "-",
"PAY_METHOD": "05",
"TRANS_AMT": 29018,
"CUSTOMER_NO": "-",
"SETTLMNT_DT": "-"
},
{
"CODE": "10",
"TXID": "IONPAYTEST02202001011041357152",
"ORDER_NO": "T21VQB05AP8KS7O",
"TRANS_STATUS": "0",
"TRANS_DT": "20200101",
"TRANS_TM": "104306",
"CANCEL_DT": "-",
"CANCEL_TM": "-",
"PAY_METHOD": "02",
"TRANS_AMT": 147033,
"CUSTOMER_NO": "70014000091041357152",
"SETTLMNT_DT": "-"
}
],
"TAIL": {
"CODE": "99",
"MID": "IONPAYTEST",
"TRANS_DT": "20200101",
"APP_TRANS_CNT": 6,
"APP_TRANS_AMT": 290087,
"CC_TRANS_CNT": 0,
"CC_TRANS_AMT": 0
}
}