/api/network/v1/enterprises/{enterpriseId}/partners/settlements
Partner route to perform a settlement. This endpoint allows partners without disputes enabled to create new settlements between client accounts, transferring funds according to the specified amounts.
Please note that this endpoint cannot be used by partners with disputes enabled, instead use the V2 Settlement endpoint. This is because dispute enabled partners must have an asyncronous settlement process to allow clients time to review the settlement and reconcile liabilities agains their trading activity on your platform. In the event that you cal this endpoint and you have disputes enabled, you will recieve a 403 response.
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 or Incomplete Settlement
Occurs when the request is not authorized or cannot be completed immediately.
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, partner is enabled for disputes.
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 or Incomplete Settlement
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues, settlement initiated but not completed due to transient errors.
enterpriseId
stringRequired>= 1 characters
externalId
string required >= 1 characters
notes
string >= 1 characters
settlementAmounts
One ofrequired
dictionary<string, string> nonce
string required >= 1 characters
payload
string required >= 1 characters
signature
string required >= 1 characters
settlement
object required id
string required partnerId
string required externalId
string required >= 1 characters
status
string required completed
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 finalizedAt
string <date-time>
required rtId
string lossSLAAlertSent
boolean required gainSLAAlertSent
boolean required cutoffAt
string <date-time>
disputed
boolean 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 error
string required error
string required 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