latestOpenAPI 3.0.32026-08-224982,0272.8 MB
e445c15e5bee
Settlements
List settlements by enterprise
List all settlements for a given enterprise.
Use only with delivery versus payment (DVP) settlements.
Requires access token scope: wallet_view_all
get/api/clearing/v1/enterprise/{enterpriseId}/settlements
Path parameters
enterpriseIdstring required
Query parameters
counterpartyAccountIdsstring[]
dateInitiatedOnOrAfterstring date-time
dateInitiatedBeforestring date-time
omitRequesterAccountNameboolean
requiresSigningboolean
typesstring[]
batchIdstring[]
externalIdsstring[]
externalIdPrefixstring
includeTotalCountboolean
Response
OK