---
title: "createSettlement"
method: POST
path: "/settlements"
tags: ["sampled", "createSettlement"]
---

# createSettlement

`POST /settlements`

## Request

- Base URL: `/v2` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v2/settlements`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/docs/settlements/post.ts> (a function with typed inputs; its response is checked against the schema)

Triggers settlement creation. Returns settlement report.

## Request body

- SettlementEventPayload
  - `settlementModel` string, required
  - `reason` string, required
  - `settlementWindows` SettlementWindowId[], required
    - `id` integer, required

## Response `200`

Created settlement with all windows and accounts.

- Settlement
  - `id` integer
  - `state` string
  - `settlementWindows` SettlementWindows[]
    - SettlementWindow[]
      - `id` integer, required
      - `reason` string
      - `state` string, required
      - `createdDate` string, required
      - `changedDate` string
      - `content` SettlementWindowContent[]
        - `id` integer, required
        - `state` string, required
        - `ledgerAccountType` string, required
        - `currencyId` string, required
        - `createdDate` string, required
        - `changedDate` string
        - `settlementId` integer
  - `participants` Participant[]
    - `id` integer
    - `accounts` Accounts[]
      - `id` integer: Participant Currency Id
      - `reason` string: TBD
      - `state` string
      - `netSettlementAmount` NetSettlementAmount
        - `amount` number
        - `currency` string

## Other responses

- `400`: Bad request.
- `401`: Authorisation information is missing or invalid.
- `404`: No data found.
- `415`: Unsupported Media Type.
- `default`: Unexpected error

## Changes

- **2026-09-08** `7fbaa3e7ca2b`: 1 breaking, 6 info
  - added required request body
  - added the media type `application/json` for the response with the status `200`
  - added the media type `application/json` for the response with the status `400`
  - added the media type `application/json` for the response with the status `401`
  - …3 more

[Operation history](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/changes/settlements/post.md)

---

[API](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements.md) - [All operations](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/llms.txt) - [OpenAPI document](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/revisions/7fbaa3e7ca2b?raw)