MOJALOOP Central Settlements

Version: 2.0

Mojaloop API for Settlements.

Schemes:

Summary

Tag: getHealth

Operation	Description
GET /health	getHealth

Tag: getSettlementWindowById

Operation	Description
GET /settlementWindows/{id}	getSettlementWindowById

Tag: updateSettlementBySettlementParticipant

Operation	Description
PUT /settlements/{sid}/participants/{pid}	updateSettlementBySettlementParticipant

Tag: getSettlementBySettlementParticipantAccount

Operation	Description
GET /settlements/{sid}/participants/{pid}/accounts/{aid}	getSettlementBySettlementParticipantAccount

Tag: updateSettlementBySettlementParticipantAccount

Operation	Description
PUT /settlements/{sid}/participants/{pid}/accounts/{aid}	updateSettlementBySettlementParticipantAccount

Tag: sampled

Operation	Description
GET /settlementWindows/{id}	getSettlementWindowById
POST /settlementWindows/{id}	closeSettlementWindow
GET /settlementWindows	getSettlementWindowsByParams
GET /settlements	getSettlementsByParams
POST /settlements	createSettlement
GET /settlements/{id}	getSettlementById
PUT /settlements/{id}	updateSettlementById
GET /settlements/{sid}/participants/{pid}	getSettlementBySettlementParticipant
PUT /settlements/{sid}/participants/{pid}	updateSettlementBySettlementParticipant
GET /settlements/{sid}/participants/{pid}/accounts/{aid}	getSettlementBySettlementParticipantAccount
PUT /settlements/{sid}/participants/{pid}/accounts/{aid}	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/{sid}/participants/{pid}	getSettlementBySettlementParticipant

Paths

getHealth

GET /health

Tags: getHealth

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

200 OK: A valid and health service.
502 Bad Gateway: API is live, but error connecting to required sub-service.

getSettlementsByParams

GET /settlements

Tags: sampled, getSettlementsByParams

Returns Settlements as per parameter(s).

Name	Description	Type	Data Type
currency	A valid currency to filter on.	query	object
participantId	A valid participant Id to filter on.	query	object
settlementWindowId	A valid Settlement Window Id to filter on.	query	object
accountId	A valid Account Id to filter on.	query	object
state	A settlement state to filter on.	query	object
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	object
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	object
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	object
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	object

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: sampled, createSettlement

Triggers settlement creation. Returns settlement report.

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: sampled, getSettlementById

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

Name	Description	Type	Data Type	Annotation
id	A valid Settlement Id.	path	object

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: sampled, updateSettlementById

Acknowledgement of settlement by updating with Settlement Id.

Name	Description	Type	Data Type	Annotation
id	A valid Settlement Id.	path	object

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/{sid}/participants/{pid}

Tags: sampled, getSettlementBySettlementParticipant

Returns Settlement(s) as per filter criteria.

Name	Description	Type	Data Type	Annotation
sid	A valid Settlement Id.	path	object
pid	A valid Participant Id.	path	object

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/{sid}/participants/{pid}

Tags: sampled, updateSettlementBySettlementParticipant

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

Name	Description	Type	Data Type	Annotation
sid	A valid Settlement Id.	path	object
pid	A valid Participant Id.	path	object

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/{sid}/participants/{pid}/accounts/{aid}

Tags: sampled, getSettlementBySettlementParticipantAccount

Returns Settlement(s) as per filter criteria.

Name	Description	Type	Data Type
sid	A valid Settlement Id.	path	object
pid	A valid Participant Id.	path	object
aid	A valid Account Id.	path	object

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/{sid}/participants/{pid}/accounts/{aid}

Tags: sampled, updateSettlementBySettlementParticipantAccount

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

Name	Description	Type	Data Type
sid	A valid Settlement Id.	path	object
pid	A valid Participant Id.	path	object
aid	A valid Account Id.	path	object

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: sampled, getSettlementWindowsByParams

Returns Settlement Windows as per parameter(s).

Name	Description	Type	Data Type
participantId	A valid participant Id to filter on.	query	object
state	A settlement window state to filter on.	query	object
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	object
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	object
currency	A valid currency to filter on.	query	object

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, sampled

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	object

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: sampled, closeSettlementWindow

Closes requested window and opens a new one.

Name	Description	Type	Data Type	Annotation
id		path	object

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

Central Settlements