MOJALOOP Central Settlements

Base URL: /v1, Version: 1.1.0

Mojaloop API for Settlements.

Schemes: http, https

Summary

Tag: getHealth

Operation Description
GET /health

getHealth

Tag: getSettlementWindowById

Operation Description
GET /settlementWindows/{id}

getSettlementWindowById

Tag: getSettlementBySettlementParticipantAccount

Operation Description
GET /settlements/{settlementId}/participants/{participantId}/accounts/{accountId}

getSettlementBySettlementParticipantAccount

Tag: updateSettlementBySettlementParticipantAccount

Operation Description
PUT /settlements/{settlementId}/participants/{participantId}/accounts/{accountId}

updateSettlementBySettlementParticipantAccount

Tag: closeSettlementWindow

Operation Description
POST /settlementWindows/{id}

closeSettlementWindow

Tag: getSettlementWindowsByParams

Operation Description
GET /settlementWindows

getSettlementWindowsByParams

Tag: getSettlementsByParams

Operation Description
GET /settlements

getSettlementsByParams

Tag: createSettlement

Operation Description
POST /settlements

createSettlement

Tag: getSettlementById

Operation Description
GET /settlements/{id}

getSettlementById

Tag: updateSettlementById

Operation Description
PUT /settlements/{id}

updateSettlementById

Tag: getSettlementBySettlementParticipant

Operation Description
GET /settlements/{settlementId}/participants/{participantId}

getSettlementBySettlementParticipant

Tag: updateSettlementBySettlementParticipant

Operation Description
PUT /settlements/{settlementId}/participants/{participantId}

updateSettlementBySettlementParticipant

Paths

getHealth

GET /health

Tags: getHealth

Gets the health of the service and sub-services (i.e. database).

application/json

200 OK

A valid and health service.

502 Bad Gateway

API is live, but error connecting to required sub-service.

getSettlementsByParams

GET /settlements

Tags: getSettlementsByParams

Returns Settlements as per parameter(s).

Name Description Type Data Type Annotation
currency

A valid currency to filter on.

query string
participantId

A valid participant Id to filter on.

query integer
settlementWindowId

A valid Settlement Window Id to filter on.

query number
accountId

A valid Account Id to filter on.

query number
state

A settlement state to filter on.

query string , x ∈ { PENDING_SETTLEMENT , PS_TRANSFERS_RECORDED , PS_TRANSFERS_RESERVED , PS_TRANSFERS_COMMITTED , SETTLING , SETTLED , ABORTED }
fromDateTime

The start date for query (relates to central-ledger.settlement.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z

query string (date-time)
toDateTime

The end date for query (relates to central-ledger.settlement.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z

query string (date-time)
fromSettlementWindowDateTime

The start date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z

query string (date-time)
toSettlementWindowDateTime

The end date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z

query string (date-time)

application/json

200 OK

Settlement window(s) returned by the filtering parameters.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

createSettlement

POST /settlements

Tags: createSettlement

Trigger the creation of a settlement, that does the calculation of the net settlement position per participant and marks all transfers in the affected windows as PENDING_SETTLEMENT. Returned dataset is the net settlement report for the settlementWindow

application/json

A JSON object containing settlement windows to be included.

application/json

200 OK

Created settlement with all windows and accounts.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

getSettlementById

GET /settlements/{id}

Tags: getSettlementById

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

Name Description Type Data Type Annotation
id

A valid Settlement Id.

path integer

application/json

200 OK

Settlement successfully returned by the filtering/Query parameters.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

updateSettlementById

PUT /settlements/{id}

Tags: updateSettlementById

Acknowledgement of settlement by updating with Settlement Id.

application/json

A JSON object containing settlement update info.

Name Description Type Data Type Annotation
id

A valid Settlement Id.

path integer

application/json

200 OK

Settlements updated.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

getSettlementBySettlementParticipant

GET /settlements/{settlementId}/participants/{participantId}

Tags: getSettlementBySettlementParticipant

Returns Settlement(s) as per filter criteria.

Name Description Type Data Type Annotation
settlementId

A valid Settlement Id.

path integer
participantId

A valid Participant Id.

path integer

application/json

200 OK

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

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

updateSettlementBySettlementParticipant

PUT /settlements/{settlementId}/participants/{participantId}

Tags: updateSettlementBySettlementParticipant

Acknowledgement of settlement by updating with Settlements Id and Participant Id.

application/json

A JSON object containing settlement update info.

Name Description Type Data Type Annotation
settlementId

A valid Settlement Id.

path integer
participantId

A valid Participant Id.

path integer

application/json

200 OK

Settlements updated.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

getSettlementBySettlementParticipantAccount

GET /settlements/{settlementId}/participants/{participantId}/accounts/{accountId}

Tags: getSettlementBySettlementParticipantAccount

Returns Settlement(s) as per filter criteria.

Name Description Type Data Type Annotation
settlementId

A valid Settlement Id.

path integer
participantId

A valid Participant Id.

path integer
accountId

A valid Account Id.

path integer

application/json

200 OK

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

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

updateSettlementBySettlementParticipantAccount

PUT /settlements/{settlementId}/participants/{participantId}/accounts/{accountId}

Tags: updateSettlementBySettlementParticipantAccount

Acknowledgement of settlement by updating the reason and state by Settlements Id, Participant Id and accounts Id.

application/json

A JSON object containing settlement update info.

Name Description Type Data Type Annotation
settlementId

A valid Settlement Id.

path integer
participantId

A valid Participant Id.

path integer
accountId

A valid Account Id.

path integer

application/json

200 OK

Settlements updated.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

getSettlementWindowsByParams

GET /settlementWindows

Tags: getSettlementWindowsByParams

Returns Settlement Windows as per parameter(s).

Name Description Type Data Type Annotation
participantId

A valid participant Id to filter on.

query integer
state

A settlement window state to filter on.

query string , x ∈ { OPEN , CLOSED , PENDING_SETTLEMENT , SETTLED , ABORTED }
fromDateTime

The start date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z

query string (date-time)
toDateTime

The end date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z

query string (date-time)

application/json

200 OK

Settlement window(s) returned by the filtering parameters.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

getSettlementWindowById

GET /settlementWindows/{id}

Tags: getSettlementWindowById

Returns a Settlement Window by id.

Name Description Type Data Type Annotation
id

A valid settlement window id to be supplied in the query.

path integer

application/json

200 OK

A settlement window's data returned.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type

default

Unexpected error

closeSettlementWindow

POST /settlementWindows/{id}

Tags: closeSettlementWindow

If the settlementWindow is open, it can be closed and a new window is created. If it is already closed, return an error message. Returns the new settlement window.

application/json

A JSON object containing settlement window closure info.

Name Description Type Data Type Annotation
id path integer

application/json

200 OK

Settlement window closed and new window opened.

400 Bad Request

Bad request.

401 Unauthorized

Authorisation information is missing or invalid.

404 Not Found

No data found.

415 Unsupported Media Type

Unsupported Media Type.

default

Unexpected error

Schema definitions

Account: object

id: string

Account Id

reason: string

TBD

state: string
"PENDING_SETTLEMENT"
                                                        
netSettlementAmount: netSettlementAmount

Accounts: object

id: integer

Participant Currency Id

reason: string

TBD

state: string
"PENDING_SETTLEMENT"
                                                        
netSettlementAmount: netSettlementAmount

Error: object

errorInformation: object
errorCode: integer
errorDescription: string
extensionList: object
extension: object[]

Extension: object

key: string
value: string

netSettlementAmount: object

amount: number
currency: string

Participant: object

id: integer
accounts: object[]

Settlement: object

id: integer
state: string
settlementWindows: object[]
participants: object[]

SettlementEventPayload: object

reason: string
settlementWindows: object[]

Settlements: object[]

SettlementUpdateBySettlementIdInnerPayload: object

id: integer

Participant Currency Id

reason: string
"reason"
                                                        
state: string , x ∈ { PENDING_SETTLEMENT , PS_TRANSFERS_RECORDED , PS_TRANSFERS_RESERVED , PS_TRANSFERS_COMMITTED , SETTLED }
"SETTLED"
                                                        
externalReference: string
"external-reference-abc123"
                                                        

SettlementUpdateBySettlementIDOuterPayload: object

id: integer

Participant Id

accounts: object[]

SettlementUpdateBySettlementIdPayload: object

state: string , x ∈ { ABORTED , INVALID }
reason: string
externalReference: string
participants: object[]

SettlementUpdateBySettlementParticipantAccount: object

state: string , x ∈ { PENDING_SETTLEMENT , PS_TRANSFERS_RECORDED , PS_TRANSFERS_RESERVED , PS_TRANSFERS_COMMITTED , SETTLED }
"SETTLED"
                                                        
reason: string
"string"
                                                        
externalReference: string
"external-reference-abc123"
                                                        

SettlementUpdateBySettlementParticipantPayload: object

SettlementWindow: object

id: integer
reason: string
state: string
createdDate: string
changedDate: string

SettlementWindowClosurePayload: object

state: string , x ∈ { CLOSED }
"CLOSED"
                                                        
reason: string
"string"
                                                        

SettlementWindowId: object

id: integer

SettlementWindows: object[]

results matching ""

    No results matching ""