/api/network/v1/enterprises/{enterpriseId}/clients/settlements/{settlementId}This API call allows clients to get a list of settlement transactions for any connected network account, for a specific settlement. The settlement and its metadata will be returned along with all related settlement transfers in and out of the clients’ network accounts.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or malformed.
Examples: Invalid UUID format for settlementId, invalid enterpriseId format.
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 settlement cannot be found.
Examples: Settlement ID doesn't exist or the calling client isn't involved in the settlement.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues.
enterpriseIdstringRequired>= 1 characterssettlementIdstringRequiredcurrenciesarray[string]pageNumberstring<integer>pageSizestringsettlementOne ofrequired id string required partnerId string required externalId string required >= 1 charactersstatus string required pendingsettlementType string required onchain offchainreconciled boolean required initiatedBy string required >= 1 charactersnotes string >= 1 characterscreatedAt string <date-time>required updatedAt string <date-time>required rtId string lossSLAAlertSent boolean required gainSLAAlertSent boolean required cutoffAt string <date-time>disputed boolean settlementTransfers array[object] required sourceTradingAccountId string >= 1 characterssourceNetworkAccountId string destinationTradingAccountId string >= 1 charactersdestinationNetworkAccountId string currency string required >= 1 charactersquantity string required txIds array[string] required status string required pending pending_onchain onchain_initiated onchain_failed completed failed rejected disputed pending_settlement_assignmentusdValueOne ofrequired settlementId string required disputeClosureId string id string required createdAt string <date-time>required updatedAt string <date-time>required settlementStatus string required failed completed pending rejectedsettlementNotes string >= 1 characterssourceClientName string >= 1 charactersdestinationClientName string >= 1 characterssourceConnectionName string >= 1 charactersdestinationConnectionName string >= 1 characterssettlingDisputes array[object] required settledInSettlementId string required disputeClosureId string required disputeClosure object required id string required createdAt string <date-time>required updatedAt string <date-time>required connectionId string required disputedSettlementId string required userId string required >= 1 charactersexpectedTransfers dictionary<string, string> required retracted boolean required reason string >= 1 charactersretractedBy string >= 1 charactersretractedAt string <date-time>retractedReason string >= 1 characterssettlementDisputes array[object] required disputeClosure object id string required createdAt string <date-time>required updatedAt string <date-time>required connectionId string required disputedSettlementId string required userId string required >= 1 charactersexpectedTransfers dictionary<string, string> required retracted boolean required settledInSettlementId string reason string >= 1 charactersretractedBy string >= 1 charactersretractedAt string <date-time>disputeClosureId string retractedReason string >= 1 characterserror string required error string required error string required error string required