Settlement History API
About Settlement History API
Settlement History API uses to reconcile settlement fund report with NICEPAY. Merchant get list of settlement data up to 5,000 data for every request that match with the needed date.
Settlement History API
API End Point | |
|---|---|
Request Method application/json | POST |
Description | To check settlement history with NICEPAY via API |
Header | Content-Type: application/json |
Request Format | application/json |
The available transaction value and settlement fund value in this report is using Rupiah currency.
Request Parameter
Parameter | Type | Size | 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 |
settlmntdt Required | VARCHAR2 | 8 | Transaction data date to be seen Format: YYYYMMDD | 20200113 |
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 |
SETTLMNT_DT Required | VARCHAR2 | 8 | The requested transaction data date Format: YYYYMMDD | 20200113 |
DATA Required | Object | - | - | "DATA": [ { ... } ] |
CODE Required | NUMBER | 2 | 10 | |
TXID Required | VARCHAR2 | 30 | Transaction ID | IONPAYTEST02202001100933358310 |
SETTLMNT_DT Required | VARCHAR2 | 8 | Settlement date, it will be shown directly if available Format: YYYYMMDD | 20200113 |
TRANS_STATUS Required | NUMBER | 2 | 0 | |
PAY_METHOD Required | VARCHAR2 | 2 | 02 | |
TRANS_DT Required | VARCHAR2 | 8 | The requested transaction data date Format: YYYYMMDD | 20200110 |
TRANS_AMT Required | NUMBER | 19,2 | Transaction Amount | 1000 |
SETTLMNT_AMT Required | NUMBER | 19,2 | Settlement Amount | 800 |
FDS_FEE Required | NUMBER | 19,2 | FDS fee (only applicable for Credit Card method) | 0 |
NICEPAY_FEE Required | NUMBER | 19,2 | NICEPAY service fee that applicable every successful paid transaction | 545 |
BANK_FEE Required | NUMBER | 19,2 | Bank or Mitra fee (only applicable for facilitator Settlement type) | 0 |
VAT Required | NUMBER | 19,2 | PPN or VAT (Value Added Tax) fee | 55 |
ORDER_NO Required | NUMBER | 10 | Merchant Reference Number | OrdNo20200933270 |
BANK_CD Required | VARCHAR2 | 4 | Bank or Mitra Code | BMRI |
CUSTOMER_NO Required | VARCHAR2 | 40 | Customer Account Transaction Number | 79150000090933358310 |
TAIL Required | Object | - | - | "TAIL": { ... } |
CODE Required | NUMBER | 4 | 99 | |
MID Required | VARCHAR2 | 10 | iMid Merchant | IONPAYTEST |
SETTLMNT_DT Required | VARCHAR2 | 8 | The Requested Settlement Data Date Format: YYYYMMDD | 20200113 |
APP_CNT Required | NUMBER | 10 | The sum of total transaction volume | 5 |
APP_AMT Required | NUMBER | 19,2 | The sum of total transaction amount | 14000 |
CC_CNT Required | NUMBER | 10 | The sum of total transaction amount | 0 |
CC_AMT Required | NUMBER | 19,2 | The sum of total transaction refund amount | 0 |
NICEPAY_FEE Required | NUMBER | 19,2 | The sum of NICEPAY service fee applicable on every successful paid transaction | 2725 |
BANK_FEE Required | NUMBER | 19,2 | The sum of total Bank or Mitra fee (only applicable for Facilitator Settlement type) | 0 |
VAT Required | NUMBER | 19,2 | The sum of total PPN or VAT (Value Added Tax) fee | 275 |
SETTLMNT_AMT Required | NUMBER | 19,2 | The sum of total Settlement amount | 11000 |
Sample Parameter
{
"HEADER": {
"CODE": "00",
"MID": "IONPAYTEST",
"SETTLMNT_DT": "20200113"
},
"DATA": [
{
"CODE": "10",
"TXID": "IONPAYTEST02202001100933358310",
"SETTLMNT_DT": "20200113",
"TRANS_STATUS": "0",
"PAY_METHOD": "02",
"TRANS_DT": "20200110",
"TRANS_AMT": 1000,
"SETTLMNT_AMT": 400,
"FDS_FEE": 0,
"NICEPAY_FEE": 545,
"BANK_FEE": 0,
"VAT": 55,
"ORDER_NO": "OrdNo20200933270",
"BANK_CD": "BDIN",
"CUSTOMER_NO": "79150000090933358310"
},
{
"CODE": "10",
"TXID": "IONPAYTEST02202001100941229936",
"SETTLMNT_DT": "20200113",
"TRANS_STATUS": "0",
"PAY_METHOD": "02",
"TRANS_DT": "20200110",
"TRANS_AMT": 1000,
"SETTLMNT_AMT": 400,
"FDS_FEE": 0,
"NICEPAY_FEE": 545,
"BANK_FEE": 0,
"VAT": 55,
"ORDER_NO": "OrdNo2020094119264",
"BANK_CD": "BMRI",
"CUSTOMER_NO": "70014000090941229936"
},
{
"CODE": "10",
"TXID": "IONPAYTEST02202001102359040783",
"SETTLMNT_DT": "20200113",
"TRANS_STATUS": "0",
"PAY_METHOD": "02",
"TRANS_DT": "20200111",
"TRANS_AMT": 10000,
"SETTLMNT_AMT": 9400,
"FDS_FEE": 0,
"NICEPAY_FEE": 545,
"BANK_FEE": 0,
"VAT": 55,
"ORDER_NO": "OrdNo20200235841270",
"BANK_CD": "CENA",
"CUSTOMER_NO": "44779000092359040783"
},
{
"CODE": "10",
"TXID": "IONPAYTEST02202001110258241837",
"SETTLMNT_DT": "20200113",
"TRANS_STATUS": "0",
"PAY_METHOD": "02",
"TRANS_DT": "20200111",
"TRANS_AMT": 1000,
"SETTLMNT_AMT": 400,
"FDS_FEE": 0,
"NICEPAY_FEE": 545,
"BANK_FEE": 0,
"VAT": 55,
"ORDER_NO": "OrdNo2020025819224",
"BANK_CD": "BRIN",
"CUSTOMER_NO": "88788000090258241837"
},
{
"CODE": "10",
"TXID": "IONPAYTEST02202001110323543251",
"SETTLMNT_DT": "20200113",
"TRANS_STATUS": "0",
"PAY_METHOD": "02",
"TRANS_DT": "20200111",
"TRANS_AMT": 1000,
"SETTLMNT_AMT": 400,
"FDS_FEE": 0,
"NICEPAY_FEE": 545,
"BANK_FEE": 0,
"VAT": 55,
"ORDER_NO": "OrdNo2020032349682",
"BANK_CD": "BMRI",
"CUSTOMER_NO": "70014000090323543251"
}
],
"TAIL": {
"CODE": "99",
"MID": "IONPAYTEST",
"SETTLMNT_DT": "20200113",
"APP_CNT": 5,
"APP_AMT": 14000,
"CC_CNT": 0,
"CC_AMT": 0,
"NICEPAY_FEE": 2725,
"BANK_FEE": 0,
"VAT": 275,
"SETTLMNT_AMT": 11000
}
}