---
title: Settlement History API
slug: en/nicepay-api-business-report-settlement-history-api
description: Information about Settlement History API from API Business Report available on the NICEPAY system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/6Munj0CffZipZN8QnPe4i_nicepay-docs-logo.png
icon: {"faIcon":"fa-solid fa-circle-arrow-up"}
docTags: 
createdAt: 2024-07-04T10:02:00.417Z
---

# 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.

:::Iframe{iframeHeight="0" code="Merchant should contact <a style=&#x22;color:blue;text-decoration-line:underline&#x22; href=&#x22;mailto:cs@nicepay.co.id&#x22;>NICEPAY Customer Service</a> by sending Merchant IP to proceed Whitelist process on NICEPAY side beforehand and request the API credential to use the Settlement History API."}

:::



# Settlement History API

***

| **API End Point**                                                     | [`https://bo.nicepay.co.id/settlmntdt.do`](https://bo.nicepay.co.id/settlmntdt.do) |
| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| **Request Method&#x20;**<font color="#2166ae">application/json</font> | ****<font color="#3b9f0f">**POST**</font>                                          |
| **Description**                                                       | To check settlement history with NICEPAY via API                                   |
| **Header**                                                            | `Content-Type: application/json`                                                   |
| **Request Format**                                                    | `application/json`                                                                 |

:::hint{type="info"}
The available transaction value and settlement fund value in this report is using Rupiah currency.
:::

## Request Parameter

| **Parameter**                                           | **Type** | **Size** | **Description**                                                                                                                                         | **Example / Note**    |
| ------------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `mid`<br /><font color="#2166ae">Required</font>        | VARCHAR2 | 10       | iMid Merchant                                                                                                                                           | IONPAYTEST            |
| `passwd`<br /><font color="#2166ae">Required</font>     | VARCHAR2 | 100      | Password gain after Whitelist IP process successfully registered on NICEPAY side<br />(Please contact **NICEPAY Customer Service team** for assistance) | 123456                |
| `settlmntdt`<br /><font color="#2166ae">Required</font> | VARCHAR2 | 8        | Transaction data date to be seen<br />Format: `YYYYMMDD`                                                                                                | 20200113              |
| `startno`<br /><font color="#2166ae">Required</font>    | NUMBER   | 10       | The beginning of the transaction data that will be seen                                                                                                 | 1<br />Default: 1     |
| `endno`<br /><font color="#2166ae">Required</font>      | NUMBER   | 10       | The last of the transaction data that will be seen, maximum 5,000                                                                                       | 100<br />Default: 100 |

## Response Parameter

| **Parameter**                                             | **Type** | **Length** | **Description**                                                                      | **Example / Note**             |
| --------------------------------------------------------- | -------- | ---------- | ------------------------------------------------------------------------------------ | ------------------------------ |
| `HEADER`<br /><font color="#2166ae">Required</font>       | Object   | -          | -                                                                                    | `"HEADER": { ... } `           |
| `CODE`<br /><font color="#2166ae">Required</font>         | NUMBER   | 4          | [Header Code Response](docId\:Mo0VnUbHoIT0btlzcz9Bg)                                 | 00                             |
| `MID`<br /><font color="#2166ae">Required</font>          | VARCHAR2 | 10         | iMid Merchant                                                                        | IONPAYTEST                     |
| `SETTLMNT_DT`<br /><font color="#2166ae">Required</font>  | VARCHAR2 | 8          | The requested transaction data date<br />Format: `YYYYMMDD`                          | 20200113                       |
| `DATA`<br /><font color="#2166ae">Required</font>         | Object   | -          | -                                                                                    | `"DATA": [  { ... } ] `        |
| `CODE`<br /><font color="#2166ae">Required</font>         | NUMBER   | 2          | [Data Code Response](docId\:Mo0VnUbHoIT0btlzcz9Bg)                                   | 10                             |
| `TXID`<br /><font color="#2166ae">Required</font>         | VARCHAR2 | 30         | Transaction ID                                                                       | IONPAYTEST02202001100933358310 |
| `SETTLMNT_DT`<br /><font color="#2166ae">Required</font>  | VARCHAR2 | 8          | Settlement date, it will be shown directly if available<br />Format: `YYYYMMDD`      | 20200113                       |
| `TRANS_STATUS`<br /><font color="#2166ae">Required</font> | NUMBER   | 2          | [Transaction Status Code](docId\:Mo0VnUbHoIT0btlzcz9Bg)                              | 0                              |
| `PAY_METHOD`<br /><font color="#2166ae">Required</font>   | VARCHAR2 | 2          | [Payment Method](docId\:Mo0VnUbHoIT0btlzcz9Bg)                                       | 02                             |
| `TRANS_DT`<br /><font color="#2166ae">Required</font>     | VARCHAR2 | 8          | The requested transaction data date<br />Format: `YYYYMMDD`                          | 20200110                       |
| `TRANS_AMT`<br /><font color="#2166ae">Required</font>    | NUMBER   | 19,2       | Transaction Amount                                                                   | 1000                           |
| `SETTLMNT_AMT`<br /><font color="#2166ae">Required</font> | NUMBER   | 19,2       | Settlement Amount                                                                    | 800                            |
| `FDS_FEE`<br /><font color="#2166ae">Required</font>      | NUMBER   | 19,2       | FDS fee (only applicable for Credit Card method)                                     | 0                              |
| `NICEPAY_FEE`<br /><font color="#2166ae">Required</font>  | NUMBER   | 19,2       | NICEPAY service fee that applicable every successful paid transaction                | 545                            |
| `BANK_FEE`<br /><font color="#2166ae">Required</font>     | NUMBER   | 19,2       | Bank or Mitra fee (only applicable for facilitator Settlement type)                  | 0                              |
| `VAT`<br /><font color="#2166ae">Required</font>          | NUMBER   | 19,2       | PPN or VAT (Value Added Tax) fee                                                     | 55                             |
| `ORDER_NO`<br /><font color="#2166ae">Required</font>     | NUMBER   | 10         | Merchant Reference Number                                                            | OrdNo20200933270               |
| `BANK_CD`<br /><font color="#2166ae">Required</font>      | VARCHAR2 | 4          | Bank or Mitra Code                                                                   | BMRI                           |
| `CUSTOMER_NO`<br /><font color="#2166ae">Required</font>  | VARCHAR2 | 40         | Customer Account Transaction Number                                                  | 79150000090933358310           |
| `TAIL`<br /><font color="#2166ae">Required</font>         | Object   | -          | -                                                                                    | `"TAIL": { ... }`              |
| `CODE`<br /><font color="#2166ae">Required</font>         | NUMBER   | 4          | [Tail Code Response](docId\:Mo0VnUbHoIT0btlzcz9Bg)                                   | 99                             |
| `MID`<br /><font color="#2166ae">Required</font>          | VARCHAR2 | 10         | iMid Merchant                                                                        | IONPAYTEST                     |
| `SETTLMNT_DT`<br /><font color="#2166ae">Required</font>  | VARCHAR2 | 8          | The Requested Settlement Data Date<br />Format: `YYYYMMDD`                           | 20200113                       |
| `APP_CNT`<br /><font color="#2166ae">Required</font>      | NUMBER   | 10         | The sum of total transaction volume                                                  | 5                              |
| `APP_AMT`<br /><font color="#2166ae">Required</font>      | NUMBER   | 19,2       | The sum of total transaction amount                                                  | 14000                          |
| `CC_CNT`<br /><font color="#2166ae">Required</font>       | NUMBER   | 10         | The sum of total transaction amount                                                  | 0                              |
| `CC_AMT`<br /><font color="#2166ae">Required</font>       | NUMBER   | 19,2       | The sum of total transaction refund amount                                           | 0                              |
| `NICEPAY_FEE`<br /><font color="#2166ae">Required</font>  | NUMBER   | 19,2       | The sum of NICEPAY service fee applicable on every successful paid transaction       | 2725                           |
| `BANK_FEE`<br /><font color="#2166ae">Required</font>     | NUMBER   | 19,2       | The sum of total Bank or Mitra fee (only applicable for Facilitator Settlement type) | 0                              |
| `VAT`<br /><font color="#2166ae">Required</font>          | NUMBER   | 19,2       | The sum of total PPN or VAT (Value Added Tax) fee                                    | 275                            |
| `SETTLMNT_AMT`<br /><font color="#2166ae">Required</font> | NUMBER   | 19,2       | The sum of total Settlement amount                                                   | 11000                          |

## Sample Parameter

:::CodeblockTabs
Request

```json
{
    "mid":"IONPAYTEST",
    "passwd":"123456",
    "settlmntdt":"20200113",
    "startno":"1",
    "endno":"5000"
}
```

Response

```json
{
  "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
  }
}
```
:::