---
title: "List all settlement batches"
method: GET
path: "/v1/settlement"
tags: ["Settlement"]
---

# List all settlement batches

`GET /v1/settlement`

## Request

- Base URL: `https://idaas.yourflexpay.com/api`
- URL: `https://idaas.yourflexpay.com/api/v1/settlement`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/reflexpay/apis/idaas-identity-as-a-service-api/docs/v1/settlement/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a paginated list of settlement batches in reverse-chronological order.
Each record contains aggregate totals; individual per-application entries are
omitted in the list view for performance. Use `GET /v1/settlement/{id}` for
full details including per-application net positions.

## Query parameters

- `pageable` Pageable, required
  - `page` integer
  - `size` integer
  - `sort` string[]

## Response `200`

Paginated list of settlement records

- ApiResponsePageSettlementRecordResponse
  - `success` boolean
  - `message` string
  - `errorCode` string
  - `data` PageSettlementRecordResponse
    - `totalElements` integer
    - `totalPages` integer
    - `first` boolean
    - `last` boolean
    - `size` integer
    - `content` SettlementRecordResponse[]
      - `id` string, uuid: Unique settlement record ID
      - `settlementDate` string, date: Calendar date (UTC) covered by this settlement batch
      - `currency` string: ISO 4217 currency code
      - `totalCredited` number: Total amount credited across all applications on this date
      - `totalDebited` number: Total amount debited across all applications on this date
      - `transactionCount` integer: Total count of completed transactions included in this batch
      - `applicationCount` integer: Number of application wallets included in this batch
      - `status` 'PENDING' | 'COMPLETED' | 'FAILED': Lifecycle status of this batch
      - `errorMessage` string: Error message if the batch failed (null when COMPLETED)
      - `createdAt` string, date-time: ISO-8601 creation timestamp
      - `entries` SettlementEntryResponse[]: Per-application net position lines
        - `id` string, uuid: Unique entry ID
        - `applicationId` string, uuid: UUID of the application
        - `applicationName` string: Name of the application
        - `walletId` string, uuid: UUID of the application's escrow wallet
        - `currency` string: ISO 4217 currency code
        - `totalCredited` number: Total incoming accepted payments for the settlement period
        - `totalDebited` number: Total outgoing accepted payments for the settlement period
        - `netAmount` number: Net position (totalCredited − totalDebited). Positive = net creditor.
        - `openingBalance` number: Wallet balance at the start of the settlement date
        - `closingBalance` number: Wallet balance at the end of the settlement date
        - `transactionCount` integer: Number of completed transactions included in this entry
        - `createdAt` string, date-time: ISO-8601 timestamp when this entry was created
    - `number` integer
    - `sort` SortObject[]
      - `direction` string
      - `nullHandling` string
      - `ascending` boolean
      - `property` string
      - `ignoreCase` boolean
    - `numberOfElements` integer
    - `pageable` PageableObject
      - `offset` integer
      - `sort` SortObject[]
        - `direction` string
        - `nullHandling` string
        - `ascending` boolean
        - `property` string
        - `ignoreCase` boolean
      - `paged` boolean
      - `unpaged` boolean
      - `pageNumber` integer
      - `pageSize` integer
    - `empty` boolean
  - `errors` string[]
  - `timestamp` string, date-time

## Changes

- **2026-04-17** `db1f954badfb`: 1 info
  - added the optional property `errorCode` to the response with the `200` status

[Operation history](https://skmtc.dev/reflexpay/apis/idaas-identity-as-a-service-api/changes/v1/settlement/get.md)

---

[API](https://skmtc.dev/reflexpay/apis/idaas-identity-as-a-service-api.md) - [All operations](https://skmtc.dev/reflexpay/apis/idaas-identity-as-a-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reflexpay/apis/idaas-identity-as-a-service-api/revisions/db1f954badfb?raw)