REST API›Settle (DVP)›Settlements

POST

Create settlement

Create a settlement request to send to your counterparty.

Use only with delivery versus payment (DVP) settlements.

Requires access token scope: wallet_spend_all

Path Params

  • enterpriseId string required

    at least 1 characters

  • accountId string required

    at least 1 characters

Header Params

  • user-id string required
  • user-agent string required
  • x-forwarded-for string required
  • token-scope string required
  • origin string
  • authorization string required

    at least 1 characters

Body Params

object

  • externalId string required

    at least 1 characters

  • expireAt string date-time
  • notation string
  • addressBookConnectionId string required
  • addressBookConnectionUpdatedAt string date-time required
  • assetTransfers array of objects required
    assetTransfers object
    • currency string required

      at least 1 characters

    • quantity string number required
  • bypassCounterpartySigning boolean
  • transactionRouteId string
  • checkForDuplicates boolean
    HTTP specific codec for create multi-currency settlement

Responses

200
OK

Response Body

object

  • id string required

    at least 1 characters

  • externalId string required

    at least 1 characters

  • expireAt string date-time
  • notation string
  • requesterAccountId string required

    at least 1 characters

  • status string enum required
    canceledpendingrejectedsettledexpiredpending-acknowledgement
  • type string enum required
    directagencydisbursement
  • bypassCounterpartySigning boolean
  • routedTransactionId string
  • clearingMethod string enum
    manualmanual-nettingautomated-netting
  • approvalRequests array of objects required
    approvalRequests object
    • id string required

      at least 1 characters

    • accountId string required

      at least 1 characters

    • status string enum required
      acknowledgedcanceledrejectedapprovedpendingfailedoverdueexpiredinitializedsignedsigningpending-acknowledgement
    • payload string required

      at least 1 characters

    • signature string

      at least 1 characters

    • policyDetailId string
    • policyDetail object
      policyDetail object
      • id string required

        at least 1 characters

      • resolutionTime string date-time required
      • resolvedBy array of strings required
    • signedAt string date-time
    • signedBy string

      at least 1 characters

    • approvedAt string date-time
    • createdAt string date-time required
    • updatedAt string date-time required
  • settlementTransfers array of objects required
    settlementTransfers object
    • id string required
    • sourceTradingAccountId string required

      at least 1 characters

    • destinationTradingAccountId string required

      at least 1 characters

    • currency string required

      at least 1 characters

    • quantity string required
    • txIds array of strings
    • estimatedFeeInNativeToken string
    • estimatedFeeInUSD string
    • createdAt string date-time required
    • updatedAt string date-time required
  • requesterAccountName string

    at least 1 characters

  • finalizedAt string date-time
  • createdAt string date-time required
  • updatedAt string date-time required
  • unlockDate string
400
Bad Request
No response body
401
Unauthorized

Response Body

object

  • error string required
  • errorName string required
403
Forbidden

Response Body

object

  • error string required
  • errorName string required
404
Not Found

Response Body

object

  • error string required
  • errorName string required
409
Conflict

Response Body

object

  • error string required
  • errorName string required
422
Unprocessable Entity

Response Body

object

  • error string required
  • errorName string required
500
Internal Server Error

Response Body

object

  • error string required
  • errorName string required