Skip to navigation
Taurus NetworkTaurus Network - Settlement

List settlements

This endpoint returns a list of settlements directed to/from the Taurus-NETWORK participant linked to the tenant.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

counterParticipantIDstringOptional
Get all the settlements where the counterParticipantID is either the creatorParticipantID or the targetParticipantID.
statuseslist of stringsOptional

Filter settlements by specifying a list of statuses. Accepted status values: 'CREATING', 'CREATED', 'REJECTED_BY_CREATOR', 'APPROVED_BY_CREATOR', 'RECEIVED', 'REJECTED_BY_TARGET', 'ACCEPTED_BY_TARGET', 'PENDING', 'COMPLETED', 'FAILED'.

sortOrderstringOptional

Set this parameter to ASC to get the (createdAt, id) sorted in ascending order or DESC to get them in descending order. By default, the order is DESC.

cursor.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSizestringOptionalformat: "uint64"
The size of the page requested. The handling service should impose a hard limit on this

Response

A successful response.
resultlist of objectsOptional
cursorobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error