Create settlement

post/api/clearing/v1/enterprise/{enterpriseId}/account/{accountId}/settlement

Create a settlement request to send to your counterparty.

Use only with delivery versus payment (DVP) settlements.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters
  • accountIdstringRequired
    Min length: >= 1 characters

Request Body

externalId string required
Min length: >= 1 characters
expireAt string <date-time>
notation string
addressBookConnectionId string required
addressBookConnectionUpdatedAt string <date-time>required
assetTransfers array[object] required
Describes an asset transfer by its currency and amount
currency string required
Min length: >= 1 characters
quantity string <number>required
bypassCounterpartySigning boolean
transactionRouteId string
checkForDuplicates boolean
HTTP specific codec for create multi-currency settlement

200 Response

id string required
Min length: >= 1 characters
externalId string required
Min length: >= 1 characters
expireAt string <date-time>
notation string
requesterAccountId string required
Min length: >= 1 characters
status string required
Allowed values: canceled pending rejected settled expired pending-acknowledgement
type string required
Allowed values: direct agency disbursement
bypassCounterpartySigning boolean
routedTransactionId string
clearingMethod string
Allowed values: manual manual-netting automated-netting
approvalRequests array[object] required
ApprovalRequestResponse with settlementId not required
id string required
Min length: >= 1 characters
accountId string required
Min length: >= 1 characters
status string required
Allowed values: acknowledged canceled rejected approved pending failed overdue expired initialized signed signing pending-acknowledgement
payload string required
Min length: >= 1 characters
signature string
Min length: >= 1 characters
policyDetailId string
policyDetail object
signedAt string <date-time>
signedBy string
Min length: >= 1 characters
approvedAt string <date-time>
createdAt string <date-time>required
updatedAt string <date-time>required
settlementTransfers array[object] required
id string required
sourceTradingAccountId string required
Min length: >= 1 characters
destinationTradingAccountId string required
Min length: >= 1 characters
currency string required
Min length: >= 1 characters
quantity string required
txIds array[string]
estimatedFeeInNativeToken string
estimatedFeeInUSD string
createdAt string <date-time>required
updatedAt string <date-time>required
requesterAccountName string
Min length: >= 1 characters
finalizedAt string <date-time>
createdAt string <date-time>required
updatedAt string <date-time>required
unlockDate string

400 Response

401 Response

error string required
errorName string required

403 Response

error string required
errorName string required

404 Response

error string required
errorName string required

409 Response

error string required
errorName string required

422 Response

error string required
errorName string required

500 Response

error string required
errorName string required