MOJALOOP Central Settlements

Base URL: /v2, Version: 2.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: 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).

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

Returns Settlements as per parameter(s).

Name	Description	Type	Data Type
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.

Settlements
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

Error

createSettlement

POST /settlements

Tags: sampled, createSettlement

Triggers settlement creation. Returns settlement report.

application/json

A JSON object containing settlement windows to be included.

SettlementEventPayload

application/json

200 OK: Created settlement with all windows and accounts.

Settlement
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

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	integer

application/json

200 OK: Settlement successfully returned by the filtering/Query parameters.

Settlement
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

Error

updateSettlementById

PUT /settlements/{id}

Tags: sampled, updateSettlementById

Acknowledgement of settlement by updating with Settlement Id.

application/json

A JSON object containing settlement update info.

SettlementUpdateBySettlementIdPayload

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

application/json

200 OK: Settlements updated.

Settlement
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

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	integer
pid	A valid Participant Id.	path	integer

application/json

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

Settlement
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

Error

updateSettlementBySettlementParticipant

PUT /settlements/{sid}/participants/{pid}

Tags: sampled, updateSettlementBySettlementParticipant

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

application/json

A JSON object containing settlement update info.

SettlementUpdateBySettlementParticipantPayload

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

application/json

200 OK: Settlements updated.

Settlement
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

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	integer
pid	A valid Participant Id.	path	integer
aid	A valid Account Id.	path	integer

application/json

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

Settlement
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

Error

updateSettlementBySettlementParticipantAccount

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

Tags: sampled, updateSettlementBySettlementParticipantAccount

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

application/json

A JSON object containing settlement update info.

SettlementUpdateBySettlementParticipantAccount

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

application/json

200 OK: Settlements updated.

Settlement
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

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	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)
currency	A valid currency to filter on.	query	string

application/json

200 OK: Settlement window(s) returned by the filtering parameters.

SettlementWindows
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

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	integer

application/json

200 OK: A settlement window's data returned.

SettlementWindow
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type

Error
default: Unexpected error

Error

closeSettlementWindow

POST /settlementWindows/{id}

Tags: sampled, closeSettlementWindow

Closes requested window and opens a new one.

application/json

A JSON object containing settlement window closure info.

SettlementWindowClosurePayload

Name	Description	Type	Data Type	Annotation
id		path	integer

application/json

200 OK: Settlement window closed and new window opened.

SettlementWindow
400 Bad Request: Bad request.

Error
401 Unauthorized: Authorisation information is missing or invalid.

Error
404 Not Found: No data found.

Error
415 Unsupported Media Type: Unsupported Media Type.

Error
default: Unexpected error

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

Extension: object

key: string
value: string

netSettlementAmount: object

amount: number
currency: string

Participant: object

id: integer
accounts: object[]: Accounts

Settlement: object

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

SettlementEventPayload: object

settlementModel: string
reason: string
settlementWindows: object[]: SettlementWindowId

Settlements: object[]

Settlement

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[]: SettlementUpdateBySettlementIdInnerPayload

SettlementUpdateBySettlementIdPayload: object

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

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

accounts: object[]: SettlementUpdateBySettlementIdInnerPayload

SettlementWindow: object

id: integer
reason: string
state: string
createdDate: string
changedDate: string
content: object[]: SettlementWindowContent

SettlementWindowClosurePayload: object

state: string , x ∈ { CLOSED }

"CLOSED"

reason: string

"string"

SettlementWindowContent: object

id: integer
state: string
ledgerAccountType: string
currencyId: string
createdDate: string
changedDate: string
settlementId: integer

MOJALOOP Central Settlements

Summary

Tag: getHealth

Tag: getSettlementWindowById

Tag: updateSettlementBySettlementParticipant

Tag: getSettlementBySettlementParticipantAccount

Tag: updateSettlementBySettlementParticipantAccount

Tag: sampled

Tag: closeSettlementWindow

Tag: getSettlementWindowsByParams

Tag: getSettlementsByParams

Tag: createSettlement

Tag: getSettlementById

Tag: updateSettlementById

Tag: getSettlementBySettlementParticipant

Paths

GET /health

GET /settlements

POST /settlements

GET /settlements/{id}

PUT /settlements/{id}

GET /settlements/{sid}/participants/{pid}

PUT /settlements/{sid}/participants/{pid}

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

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

GET /settlementWindows

GET /settlementWindows/{id}

POST /settlementWindows/{id}

Schema definitions

Account: object

Accounts: object

Error: object

Extension: object

netSettlementAmount: object

Participant: object

Settlement: object

SettlementEventPayload: object

Settlements: object[]

SettlementUpdateBySettlementIdInnerPayload: object

SettlementUpdateBySettlementIDOuterPayload: object

SettlementUpdateBySettlementIdPayload: object

SettlementUpdateBySettlementParticipantAccount: object

SettlementUpdateBySettlementParticipantPayload: object

SettlementWindow: object

SettlementWindowClosurePayload: object

SettlementWindowContent: object

SettlementWindowId: object

SettlementWindows: object[]

results matching ""

No results matching ""