---
title: "Get a settlement batch by date"
method: GET
path: "/v1/settlement/date/{date}"
tags: ["Settlement"]
---

# Get a settlement batch by date

`GET /v1/settlement/date/{date}`

## Request

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

Returns the settlement record for a specific calendar date (ISO-8601 format: `YYYY-MM-DD`).

## Path parameters

- `date` string, date, required

## Response `200`

Settlement record found

- ApiResponseSettlementRecordResponse
  - `success` boolean
  - `message` string
  - `errorCode` string
  - `data` SettlementRecordResponse: End-of-day settlement batch aggregating all completed transaction movements
    - `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
  - `errors` string[]
  - `timestamp` string, date-time

## Other responses

- `404`: No settlement found for the specified date

## Changes

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

[Operation history](https://skmtc.dev/reflexpay/apis/idaas-identity-as-a-service-api/changes/v1/settlement/date/:date/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)