Ctrl+K

List settlements by enterprise

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

List settlements by enterprise.

Path Parameters

  • enterpriseIdstringRequired

Query Parameters

  • limitstringRequired
  • offsetstringRequired
  • statusstring
    Enum: canceled rejected pending failed expired settled

200 Response

settlementList array[SettlementResponse] required
approvalRequests array[ApprovalRequestResponseForSettlement] required
settlementTransfers array[SettlementTransferResponse] 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