> For the complete documentation index, see [llms.txt](https://monicredit.gitbook.io/mc-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://monicredit.gitbook.io/mc-api/reports/settlement-bank-report.md).

# Settlement Bank Report

### Introduction

The Settlement Bank Report provides a comprehensive overview of financial settlements, offering insights into transactions and ensuring transparency in your financial processes. This report is an essential tool for tracking settlements, facilitating reconciliation, and maintaining accurate financial records.

To access the Settlement Bank Report, use the following API endpoint:

Endpoint: GET - {{baseUrl}}/v1/reports/settlement-bank

| Parameter            | Required | Type   |
| -------------------- | -------- | ------ |
| settlement\_bank\_id | no       | string |
| search               | no       | string |

#### Example Request

To retrieve data from the Settlement Bank Report, make a GET request using a tool like cURL. Replace "YOUR\_BEARER\_TOKEN" with the actual bearer token obtained through the authentication process

{% tabs %}
{% tab title="JavaScript" %}

```javascript
//A code snippet of how to consume the API

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2RlbW8ubW9uaWNyZWRpdC5jb20vYXBpL3YxL2NvcmUvYXV0aC9sb2dpbiIsImlhdCI6MTY2ODk2NzQ0MywiZXhwIjoxNjY4OTcxMDQzLCJuYmYiOjE2Njg5Njc0NDMsImp0aSI6ImF0UE9GVHE4cU4yN2lBWlciLCJzdWIiOiJVU0FETUlOIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.shrbQUV29vXRF30qMeBN3zxlc5JXd03QyMeD6ekzudU");

var raw = "";

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://demo.backend.monicredit.com/api/v1/reports/settlement-bank", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

{% endtab %}

{% tab title="PHP" %}

<pre class="language-php"><code class="lang-php">//A code snippet of how to consume the API
<strong>
</strong><strong>&#x3C;?php
</strong>
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://demo.backend.monicredit.com/api/v1/reports/settlement-bank',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2RlbW8ubW9uaWNyZWRpdC5jb20vYXBpL3YxL2NvcmUvYXV0aC9sb2dpbiIsImlhdCI6MTY2ODk2NzQ0MywiZXhwIjoxNjY4OTcxMDQzLCJuYmYiOjE2Njg5Njc0NDMsImp0aSI6ImF0UE9GVHE4cU4yN2lBWlciLCJzdWIiOiJVU0FETUlOIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.shrbQUV29vXRF30qMeBN3zxlc5JXd03QyMeD6ekzudU'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
</code></pre>

{% endtab %}

{% tab title="cURL" %}

```sh
//A code snippet of how to consume the API

curl -X GET \
  {{baseUrl}}/v1/reports/settlement-bank \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN"
```

{% endtab %}
{% endtabs %}

#### Response

```json
[
    {
        "id": "SB000000",
        "settle_bank_name": "MAIN-ACC",
        "settlement_bank_name": "Wema",
        "account_name": "Test Testing",
        "account_no": "7760000000",
        "merchant_id": "MC0000000",
        "business_name": "Test Testing",
        "total_transaction_count": 2,
        "settlement_count": 0,
        "transfer_count": 2,
        "card_count": 0,
        "transfer_total": 10000,
        "card_total": 0,
        "collection": 10000,
        "settlement": 0,
        "balance": 10000
    },
]
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://monicredit.gitbook.io/mc-api/reports/settlement-bank-report.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.