/api/network/v1/enterprises/{enterpriseId}/partners/settlements/onchain
Partner route to initiate an on-chain settlement. This endpoint allows partners to create settlements that will be processed on a blockchain, with multi-phase settlement flow.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or malformed.
Examples: Invalid format for settlement amounts, missing required fields, invalid signature.
401: Authentication Error
Occurs when the request is not authorized.
Examples: Caller is not a member of the enterprise, signature verification failed.
403: Permission Denied Error
Occurs when the authenticated partner doesn't have necessary permissions.
Examples: Enterprise does not have OES license, on-chain settlements not enabled.
409: Conflict Error
Occurs when the request conflicts with current state.
Examples: Settlement already exists with the same externalId and different properties.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues.
enterpriseId
stringRequired>= 1 characters
externalId
string required >= 1 characters
notes
string >= 1 characters
settlementAmounts
dictionary<string, object> required
dictionary<string, string> nonce
string required >= 1 characters
payload
string required >= 1 characters
signature
string required >= 1 characters
settlement
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 settlement
object 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