PUT /settlements/{id} – MOJALOOP Central Settlements

sampled

updateSettlementById

Changed on Sep 8, 2026

Acknowledgement of settlement by updating with Settlement Id.

put/settlements/{id}

Request

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

Path parameters

idinteger required

A valid Settlement Id.

Request body

state'ABORTED' | 'INVALID'

reasonstring

externalReferencestring

Example request

{
  "participants": [
    {
      "accounts": [
        {
          "reason": "reason",
          "state": "SETTLED",
          "externalReference": "external-reference-abc123"
        }
      ]
    }
  ]
}

Response

Settlements updated.

idinteger

statestring

Example response

{
  "participants": [
    {
      "accounts": [
        {
          "state": "PENDING_SETTLEMENT"
        }
      ]
    }
  ]
}

Changes

Sep 8, 20267fbaa3e7ca2b Revision changes
- breaking
  added required request body
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status

Operation history