> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.shimi.cash/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.shimi.cash/_mcp/server.

# List Settlement Ledger Transactions

GET https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions

List the full debit/credit ledger across your settlement accounts (payouts, VTU purchases, collections, etc.).

**Query parameters**
| Field | Type | Required | Notes |
|---|---|---|---|
| `page` | integer | no | Default 1 |
| `pageSize` | integer | no | Default 50, max 100 |

**Behaviour notes**
- Newest first. The list is at `data.data`, with pagination in `data.meta`.
- `status` is a **boolean**: `true` = settled/confirmed, `false` = pending, failed or reversed.
- `type` casing is inconsistent: payouts are `debit` and virtual-account credits are `CREDIT`.
- `source` is e.g. `API` or `VIRTUAL_ACCOUNT`.
- For payouts, `reference` is the payout reference (`verify_id`).

Reference: https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/list-settlement-ledger-transactions

## Authentication

- `Authorization` header (bearer token, required) — Access token from Generate Access Token (valid 15 minutes).

## Request

### Query parameters

- `page` (string, optional)
- `pageSize` (string, optional)

## Response

### 200

OK

- `status` (string, optional)
- `data` (SettlementTransactionsGetResponsesContentApplicationJsonSchemaData, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `status` (string, optional)
- `message` (string, optional)

### 401 Unauthorized Error

Unauthorized

- `message` (string, optional)

### 403 Forbidden Error

Invalid or expired access token / KYB not approved / Account deactivated

- `message` (string, optional)
- `code` (string, optional)
- `kybStatus` (string, optional)

## Types

### SettlementTransactionsGetResponsesContentApplicationJsonSchemaData

- `data` (list of SettlementTransactionsGetResponsesContentApplicationJsonSchemaDataDataItems, optional)
- `meta` (SettlementTransactionsGetResponsesContentApplicationJsonSchemaDataMeta, optional)

### SettlementTransactionsGetResponsesContentApplicationJsonSchemaDataDataItems

- `amount` (integer, optional)
- `type` (string, optional)
- `status` (boolean, optional)
- `reference` (string, optional)
- `previous_balance` (double, optional)
- `current_balance` (double, optional)
- `fee` (integer, optional)
- `source` (string, optional)
- `narration` (string, optional)
- `createdAt` (string, optional)
- `currency` (SettlementTransactionsGetResponsesContentApplicationJsonSchemaDataDataItemsCurrency, optional)
- `customer` (string, optional, nullable)

### SettlementTransactionsGetResponsesContentApplicationJsonSchemaDataMeta

- `page` (integer, optional)
- `pageSize` (integer, optional)
- `totalItems` (integer, optional)
- `totalPages` (integer, optional)
- `hasNextPage` (boolean, optional)
- `hasPrevPage` (boolean, optional)
- `nextPage` (string, optional, nullable)
- `prevPage` (string, optional, nullable)
- `from` (integer, optional)
- `to` (integer, optional)

### SettlementTransactionsGetResponsesContentApplicationJsonSchemaDataDataItemsCurrency

- `name` (string, optional)

## Examples

**Response**

```json
{
  "status": "success",
  "data": {
    "data": [
      {
        "amount": 50000,
        "type": "debit",
        "status": true,
        "reference": "cmgb3n7q20007lp4x9s1t6e8d",
        "previous_balance": 2500800.5,
        "current_balance": 2450750.5,
        "fee": 50,
        "source": "API",
        "narration": "Vendor payment",
        "createdAt": "2026-10-04T11:02:18.330Z",
        "currency": {
          "name": "NGN"
        },
        "customer": null
      },
      {
        "amount": 5000,
        "type": "CREDIT",
        "status": true,
        "reference": "cmgd2j6k50003mn8z4q7r1s9t",
        "previous_balance": 2495850.5,
        "current_balance": 2500800.5,
        "fee": 50,
        "source": "VIRTUAL_ACCOUNT",
        "narration": "Credit from virtual account ADEBAYO TUNDE 0123456780",
        "createdAt": "2026-10-04T10:41:55.812Z",
        "currency": {
          "name": "NGN"
        },
        "customer": null
      }
    ],
    "meta": {
      "page": 1,
      "pageSize": 50,
      "totalItems": 2,
      "totalPages": 1,
      "hasNextPage": false,
      "hasPrevPage": false,
      "nextPage": null,
      "prevPage": null,
      "from": 1,
      "to": 2
    }
  }
}
```

**SDK Code**

```python 200 Success
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions"

querystring = {"page":"1","pageSize":"50"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript 200 Success
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions?page=1&pageSize=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 Success
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions?page=1&pageSize=50"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 Success
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions?page=1&pageSize=50")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 Success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions?page=1&pageSize=50")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 Success
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions?page=1&pageSize=50', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 Success
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions?page=1&pageSize=50");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Success
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/settlement/transactions?page=1&pageSize=50")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```