/api/network/v1/enterprises/{enterpriseId}/clients/settlements
This API call allows clients to get a list of settlements that involve their accounts and their metadata. Results can be filtered by various parameters and are paginated.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or malformed.
Examples: Invalid UUID format, invalid pagination parameters.
401: Authentication Error
Occurs when the request is not authorized.
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated client doesn't have necessary permissions.
Examples: Enterprise does not have OES license.
404: Not Found Error
Occurs when the specified enterprise cannot be found.
Examples: Enterprise ID doesn't exist.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues, query errors.
enterpriseId
stringRequired>= 1 characters
pageNumber
string<integer>
pageSize
stringsettlementIds
array[string]onlyShowDisputed
booleanpartnerIds
array[string]partyConnectionIds
array[string]counterpartyConnectionIds
array[string]settlements
required id
string required partnerId
string required externalId
string required >= 1 characters
status
string required pending
settlementType
string required onchain
offchain
reconciled
boolean required initiatedBy
string required >= 1 characters
notes
string >= 1 characters
createdAt
string <date-time>
required updatedAt
string <date-time>
required rtId
string lossSLAAlertSent
boolean required gainSLAAlertSent
boolean required cutoffAt
string <date-time>
disputed
boolean error
string required error
string required error
string required error
string required