Settlement History API
7 min
about settlement history api history uses to reconcile settlement fund report with get list of settlement data up to 5,000 data for every request that match with needed date settlement history api api end point https //bo nicepay co id/settlmntdt do https //bo nicepay co id/settlmntdt do request method \<font color="#2166ae">application/json\</font> \<font color="#3b9f0f">post\</font> description to check settlement history with via header content type application/json request format application/json the available value and settlement fund value in this report is using rupiah currency request parameter parameter type size description example / note mid \<font color="#2166ae">required\</font> varchar2 10 imid ionpaytest passwd \<font color="#2166ae">required\</font> varchar2 100 password gain after whitelist ip successfully registered on side ( contact nicepay customer service team for assistance) 123456 settlmntdt \<font color="#2166ae">required\</font> varchar2 8 transaction data date to be seen format yyyymmdd 20200113 startno \<font color="#2166ae">required\</font> number 10 the beginning of data that will be seen 1 default 1 endno \<font color="#2166ae">required\</font> number 10 the last of data that will be seen, maximum 5,000 100 default 100 response parameter parameter type length description example / note header \<font color="#2166ae">required\</font> object "header" { } code \<font color="#2166ae">required\</font> number 4 header code response docid\ mo0vnubhoit0btlzcz9bg 00 mid \<font color="#2166ae">required\</font> varchar2 10 imid ionpaytest settlmnt dt \<font color="#2166ae">required\</font> varchar2 8 the requested data date format yyyymmdd 20200113 data \<font color="#2166ae">required\</font> object "data" \[ { } ] code \<font color="#2166ae">required\</font> number 2 data code response docid\ mo0vnubhoit0btlzcz9bg 10 txid \<font color="#2166ae">required\</font> varchar2 30 transaction id ionpaytest02202001100933358310 settlmnt dt \<font color="#2166ae">required\</font> varchar2 8 date, it will be shown directly if available format yyyymmdd 20200113 trans status \<font color="#2166ae">required\</font> number 2 transaction status code docid\ mo0vnubhoit0btlzcz9bg 0 pay method \<font color="#2166ae">required\</font> varchar2 2 payment method docid\ mo0vnubhoit0btlzcz9bg 02 trans dt \<font color="#2166ae">required\</font> varchar2 8 the requested data date format yyyymmdd 20200110 trans amt \<font color="#2166ae">required\</font> number 19,2 transaction amount 1000 settlmnt amt \<font color="#2166ae">required\</font> number 19,2 amount 800 fds fee \<font color="#2166ae">required\</font> number 19,2 fds fee (only applicable for method) 0 nicepay fee \<font color="#2166ae">required\</font> number 19,2 fee that applicable every successful paid 545 bank fee \<font color="#2166ae">required\</font> number 19,2 or fee (only applicable for facilitator type) 0 vat \<font color="#2166ae">required\</font> number 19,2 ppn or (value added tax) fee 55 order no \<font color="#2166ae">required\</font> number 10 reference number ordno20200933270 bank cd \<font color="#2166ae">required\</font> varchar2 4 or code bmri customer no \<font color="#2166ae">required\</font> varchar2 40 account transaction number 79150000090933358310 tail \<font color="#2166ae">required\</font> object "tail" { } code \<font color="#2166ae">required\</font> number 4 tail code response docid\ mo0vnubhoit0btlzcz9bg 99 mid \<font color="#2166ae">required\</font> varchar2 10 imid ionpaytest settlmnt dt \<font color="#2166ae">required\</font> varchar2 8 the requested data date format yyyymmdd 20200113 app cnt \<font color="#2166ae">required\</font> number 10 the sum of total volume 5 app amt \<font color="#2166ae">required\</font> number 19,2 the sum of total amount 14000 cc cnt \<font color="#2166ae">required\</font> number 10 the sum of total amount 0 cc amt \<font color="#2166ae">required\</font> number 19,2 the sum of total refund amount 0 nicepay fee \<font color="#2166ae">required\</font> number 19,2 the sum of fee applicable on every successful paid 2725 bank fee \<font color="#2166ae">required\</font> number 19,2 the sum of total or fee (only applicable for type) 0 vat \<font color="#2166ae">required\</font> number 19,2 the sum of total ppn or (value added tax) fee 275 settlmnt amt \<font color="#2166ae">required\</font> number 19,2 the sum of total amount 11000 sample parameter request { "mid" "ionpaytest", "passwd" "123456", "settlmntdt" "20200113", "startno" "1", "endno" "5000" } response { "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 } }