Get all counterparties
Lists counterparties for the organization. Counterparties are organization-scoped and may be linked to many customers through external accounts (many-to-many): the same counterparty can be paid by more than one customer. Use customerId to return only counterparties linked to that customer via an account.
Query parameters
Number of results to return (1-1000). Use with offset for traditional pagination.
Number of results to skip. Use with limit for traditional pagination.
Number of results per page (1-1000). Use with starting_after for cursor-based pagination.
Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.
Search counterparties by name
Filter to counterparties linked to this customer through an account. Counterparties are organization-scoped and shared across customers — the same counterparty can appear for multiple customers when each has a linked account.
Headers
API key
Response
Counterparties retrieved successfully
Example response
{
"data": [
{
"id": "cp_abc123",
"name": "Jane Doe",
"beneficiaryType": "INDIVIDUAL",
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postalCode": "94102",
"country": "US",
"transliterated": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 4B",
"city": "Beijing",
"state": "Hebei"
}
}
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.