Get Queue Settlement

get/api/clearing/v1/enterprise/{enterpriseId}/account/{accountId}/settlements/queue

Path Parameters

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

Query Parameters

  • limitstring or numberRequired
  • offsetstring or numberRequired
  • priorityGroupsarray[string]
    Enum: Very High High Medium Low
  • counterpartyAccountIdsarray[string]
    Min length: >= 1 characters
  • settlementIdsarray[string]
    Min length: >= 1 characters
  • statusesarray[string]
    Enum: canceled pending rejected settled expired pending-acknowledgement
  • createdAfterstring<date-time>
  • createdBeforestring<date-time>

200 Response

Array of
id number required
accountId string required
settlementId string required
priorityGroup string required
Allowed values: Very High High Medium Low
active boolean required
processing boolean required
settlement 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
createdAt string <date-time>required
updatedAt string <date-time>required

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