REST API›Settle (DVP)›Settlements

GET

List settlements by Go Account

List all settlements for a given Go Account.

Use only with delivery versus payment (DVP) settlements.

Requires access token scope: wallet_view_all

Path Params

  • enterpriseId string required

    at least 1 characters

  • accountId string required

    at least 1 characters

Query Params

  • limit string or number required

    ONE OF

    string
  • offset string or number required

    ONE OF

    string
  • status string or array of strings

    ONE OF

    string enum
  • counterpartyAccountIds array of strings
  • dateInitiatedOnOrAfter string date-time
  • dateInitiatedBefore string date-time
  • omitRequesterAccountName boolean
  • requiresSigning boolean
  • types array of string enums
    directagencydisbursement
  • batchId array of strings
  • externalIds array of strings
  • externalIdPrefix string

    at least 1 characters

  • includeTotalCount boolean

Responses

200
OK

Response Body

object

  • settlementList array of objects required
    settlementList 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
  • totalCount number
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
500
Internal Server Error

Response Body

object

  • error string required
  • errorName string required