Settlement History API
Tentang Settlement History API
Settlement History API dapat digunakan untuk rekonsiliasi laporan dana Settlement dengan NICEPAY. Dengan API ini, Merchant akan mendapatkan daftar data Settlement hingga 5.000 data per request sesuai dari tanggal yang diminta.
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 |
Nilai transaksi dan nilai dana Settlement yang tersedia dalam laporan ini menggunakan mata uang Rupiah.
Request Parameter
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
mid Required | VARCHAR2 | 10 | iMid Merchant | IONPAYTEST |
passwd Required | VARCHAR2 | 100 | Password setelah proses Whitelist IP telah berhasil di-register di sisi NICEPAY (Mohon untuk menghubungi tim NICEPAY Customer Service untuk asistensi) | 123456 |
settlmntdt Required | VARCHAR2 | 8 | Tanggal data transaksi yang mau dilihat Format: YYYYMMDD | 20200113 |
startno Required | NUMBER | 10 | Awal dari data transaksi yang akan mau dilihat | 1 Default: 1 |
endno Required | NUMBER | 10 | Akhir dari data transaksi yang mau dilihat Maksimal 5000 | 100 Default: 100 |
Response Parameter
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
HEADER Required | Object | - | - | "HEADER": { ... } |
CODE Required | NUMBER | 4 | Code Response | 00 |
MID Required | VARCHAR2 | 10 | iMid Merchant | IONPAYTEST |
SETTLMNT_DT Required | VARCHAR2 | 8 | Tanggal data Settlement yang di-request Format: YYYYMMDD | 20200113 |
DATA Required | Object | - | - | "DATA": [ { ... } ] |
CODE Required | NUMBER | 2 | Code Response | 10 |
TXID Required | VARCHAR2 | 30 | ID Transaksi | IONPAYTEST02202001100933358310 |
SETTLMNT_DT Required | VARCHAR2 | 8 | Tanggal data Settlement yang di-request Format: YYYYMMDD | 20200113 |
TRANS_STATUS Required | NUMBER | 2 | Status Transaksi: Transaction Status Code | 0 |
PAY_METHOD Required | VARCHAR2 | 2 | Payment Method | 02 |
TRANS_DT Required | VARCHAR2 | 8 | Tanggal data transaksi yang di-request Format: YYYYMMDD | 20200110 |
TRANS_AMT Required | NUMBER | 19,2 | Amount Transaksi | 1000 |
SETTLMNT_AMT Required | NUMBER | 19,2 | Amount Settlement | 800 |
FDS_FEE Required | NUMBER | 19,2 | Biaya FDS (hanya dikenakan untuk metode Kartu Kredit) | 0 |
NICEPAY_FEE Required | NUMBER | 19,2 | Biaya service NICEPAY yang dikenakan pada setiap transaksi yang berhasil terbayar | 545 |
BANK_FEE Required | NUMBER | 19,2 | Biaya Bank atau Mitra (akan dikenakan untuk tipe Settlement Fasilitator) | 0 |
VAT Required | NUMBER | 19,2 | Biaya PPN atau VAT (Value Added Tax) | 55 |
ORDER_NO Required | NUMBER | 10 | Nomor Referensi Merchant | OrdNo20200933270 |
BANK_CD Required | VARCHAR2 | 4 | Code Bank atau Mitra | BMRI |
CUSTOMER_NO Required | VARCHAR2 | 40 | Customer Account Transaction Number | 79150000090933358310 |
TAIL Required | Object | - | - | "TAIL": { ... } |
CODE Required | NUMBER | 4 | Code Response | 99 |
MID Required | VARCHAR2 | 10 | iMid Merchant | IONPAYTEST |
SETTLMNT_DT Required | VARCHAR2 | 8 | Tanggal data Settlement yang di-request Format: YYYYMMDD | 20200113 |
APP_CNT Required | NUMBER | 10 | Jumlah total volume transaksi | 5 |
APP_AMT Required | NUMBER | 19,2 | Jumlah total amount transaksi | 14000 |
CC_CNT Required | NUMBER | 10 | Jumlah total volume transaksi refund | 0 |
CC_AMT Required | NUMBER | 19,2 | Jumlah total amount transaksi refund | 0 |
NICEPAY_FEE Required | NUMBER | 19,2 | Jumlah total biaya service NICEPAY yang dikenakan pada setiap transaksi yang berhasil terbayar | 2725 |
BANK_FEE Required | NUMBER | 19,2 | Jumlah total biaya Bank atau Mitra (akan dikenakan hanya untuk tipe Settlement Fasilitator) | 0 |
VAT Required | NUMBER | 19,2 | Jumlah total biaya PPN atau VAT (Value Added Tax) | 275 |
SETTLMNT_AMT Required | NUMBER | 19,2 | Jumlah total amount Settlement | 11000 |
Sample Parameter
{
"mid":"IONPAYTEST",
"passwd":"123456",
"settlmntdt":"20200113",
"startno":"1",
"endno":"5000"
}