v1

latestSwagger 2.02026-07-17121946.0 KB
sampled
updateSettlementById

updateSettlementById

Acknowledgement of settlement by updating with Settlement Id.

put/settlements/{id}

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"
        }
      ]
    }
  ]
}