GET /settlements/{sid}/participants/{pid} – MOJALOOP Central Settlements

sampled

getSettlementBySettlementParticipant

Returns Settlement(s) as per filter criteria.

get/settlements/{sid}/participants/{pid}

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/:sid/participants/:pid/get.ts
A function with typed inputs. Its response is checked against the schema.

sidinteger required

A valid Settlement Id.

pidinteger required

A valid Participant Id.

Settlement, settlement windows and settlement accounts returned by the filtering parameters.

idinteger

statestring

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