/api/network/v1/enterprises/{enterpriseId}/partners/settlements/{settlementId}
Returns a settlement for your OES partner account by its ID. This endpoint provides detailed information about a specific settlement, including its status, amounts, and related transfers.
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 partner 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 doesn't belong to this partner.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues.
enterpriseId
stringRequired>= 1 characters
settlementId
stringRequiredsourceNetworkAccountIds
array[string]sourceTradingAccountIds
array[string]destinationNetworkAccountIds
array[string]destinationTradingAccountIds
array[string]currencies
array[string]pageNumber
string<integer>
pageSize
stringsettlement
One ofrequired 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 settlementTransfers
array[object] required id
string required createdAt
string <date-time>
required updatedAt
string <date-time>
required currency
string required >= 1 characters
settlementId
string required disputeClosureId
string quantity
string required txIds
array[string] required status
string required pending
pending_onchain
onchain_initiated
onchain_failed
completed
failed
rejected
disputed
pending_settlement_assignment
sourceTradingAccountId
string required >= 1 characters
sourceNetworkAccountId
string destinationTradingAccountId
string required >= 1 characters
destinationNetworkAccountId
string required settlingDisputes
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 characters
expectedTransfers
dictionary<string, string> required retracted
boolean required reason
string >= 1 characters
retractedBy
string >= 1 characters
retractedAt
string <date-time>
retractedReason
string >= 1 characters
settlementDisputes
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 characters
expectedTransfers
dictionary<string, string> required retracted
boolean required settledInSettlementId
string reason
string >= 1 characters
retractedBy
string >= 1 characters
retractedAt
string <date-time>
disputeClosureId
string retractedReason
string >= 1 characters
error
string required error
string required error
string required error
string required