List settlements by enterprise

get/api/clearing/v1/enterprise/{enterpriseId}/settlements

List all settlements for a given enterprise.

Use only with delivery versus payment (DVP) settlements.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Query Parameters

  • limitstring or numberRequired
  • offsetstring or numberRequired
  • statusstring or array
  • counterpartyAccountIdsarray[string]
    Min length: >= 1 characters
  • dateInitiatedOnOrAfterstring<date-time>
  • dateInitiatedBeforestring<date-time>
  • omitRequesterAccountNameboolean
  • requiresSigningboolean
  • typesarray[string]
    Enum: direct agency disbursement
  • batchIdarray[string]
  • externalIdsarray[string]
    Min length: >= 1 characters
  • externalIdPrefixstring
    Min length: >= 1 characters
  • includeTotalCountboolean

200 Response

settlementList array[object] required
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
settlementTransfers array[object] required
requesterAccountName string
Min length: >= 1 characters
finalizedAt string <date-time>
createdAt string <date-time>required
updatedAt string <date-time>required
unlockDate string
totalCount number

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

500 Response

error string required
errorName string required