Ctrl+K

List settlements by enterprise

get/api/clearing/v1/enterprise/{enterpriseId}/settlements

List settlements by enterprise.

Path Parameters

  • enterpriseIdstringRequired

Query Parameters

  • limitstringDefault: 50
  • offsetstringDefault: 0
  • statusstring
    Enum: canceled rejected pending failed expired settled
  • includeTotalCountboolean
    When true, includes totalCount in the response

200 Response

totalCount integer
Total count of settlements matching the query (only present when includeTotalCount=true)
Minimum: >= 0
settlementList array[object] required
approvalRequests array[object] required
settlementTransfers array[object] required
requesterAccountName string required
finalizedAt string <date>
createdAt string <date>required
updatedAt string <date>required
id string required
externalId string required
notation string
requesterAccountId string required
status string required
Allowed values: canceled rejected pending failed expired settled
type string required
Allowed value: direct

400 Response

401 Response

error string required
errorName string required

404 Response

error string required
errorName string required

500 Response

error string required
errorName string required