List Client Settlements


This API call allows clients to get a list of settlements that involve their accounts and their metadata.

Path Parameters

  • enterpriseIdstringRequired

Query Parameters

  • pageNumberstring
  • pageSizestring
  • partnerIdsarray[string]
  • partyConnectionIdsarray[string]
  • counterpartyConnectionIdsarray[string]
  • settlementIdsarray[string]

200 Response

status string required
Allowed value: pending
notes string
reason string
createdAt string <date>required
updatedAt string <date>required
id string required
partnerId string required
externalId string required
reconciled boolean required
initiatedBy string required

400 Response

401 Response

error string required

404 Response

error string required

500 Response

error string required