Sign in

v1

latestSwagger 2.02026-07-17121946.0 KB
sampled
updateSettlementBySettlementParticipantAccount

updateSettlementBySettlementParticipantAccount

Acknowledgement of settlement by updating the reason and state by SPA.

put/settlements/{sid}/participants/{pid}/accounts/{aid}

Path parameters

sidinteger required

A valid Settlement Id.

pidinteger required

A valid Participant Id.

aidinteger required

A valid Account Id.

Request body

state'PENDING_SETTLEMENT' | 'PS_TRANSFERS_RECORDED' | 'PS_TRANSFERS_RESERVED' | 'PS_TRANSFERS_COMMITTED' | 'SETTLED' required
reasonstring required
externalReferencestring

Example request

{
  "state": "SETTLED",
  "reason": "string",
  "externalReference": "external-reference-abc123"
}

Response

Settlements updated.

idinteger
statestring

Example response

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