List settlements

get

https://your-protect-instance.example.com/api/rest/v1/tn/settlements

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

Query Params

counterParticipantID

string

Get all the settlements where the counterParticipantID is either the creatorParticipantID or the targetParticipantID.

statuses

array of strings

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'.

statuses

sortOrder

string

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.currentPage

string

Base64-encoded string representing the current window of data

cursor.pageRequest

string

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

cursor.pageSize

string

The size of the page requested. The handling service should impose a hard limit on this

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.