GET /settlements/{id} – MOJALOOP Central Settlements

sampled

getSettlementById

Returns Settlement(s) as per parameters/filter criteria.

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

idinteger required

A valid Settlement Id.

Settlement successfully returned by the filtering/Query parameters.

idinteger

statestring

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