GET
/
counterparties

To initiate a settlement you need to know the counterpartyId. You can find it using this API.

Query Parameters

search
string

Search string

offset
string

Offset for pagination

limit
string
default: 1000

Limit for pagination

isConnected
boolean

Filter by connection status

counterpartyIds
string[]

Filter by counterparty IDs

counterpartyTypes
enum<string>[]

Counterparty types list. See details

Available options:
standard,
clearloop-exchange,
agency-desk
includeRelatedCounterpartyIds
boolean
default: true

Include related counterparty IDs

includeConnections
boolean
default: true

Include connections

includeCounterpartyDetails
boolean
default: true

Include counterparty details

Response

200 - application/json
counterparties
object[]
required

Counterparties list

IntroductionFind supported currencies