API Docs
API referenceCounterparties

Delete a counterparty

DELETE/api/v2/counterparties/{id}

Refused while a payout to it is created, approved, requested, or failed. A deleted counterparty is gone from the API: every endpoint answers 404 COUNTERPARTY_NOT_FOUND for it, and its customId is free again. Payouts to it keep its id in recipient.counterpartyId. Needs counterparties:write.

Path Parameters

id*string

The counterparty id (counterparty_…) or your customId.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/counterparties/counterparty_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e"
{  "object": "counterparty",  "id": "counterparty_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e",  "deleted": true}

Update a counterparty PATCH

An omitted field is unchanged; a nested object is replaced as a whole and `null` clears it. A change to the address, payment method, or tax data moves every `approved` payout to this counterparty back to `created`. Needs `counterparties:write`.

List countries GET

Every country a counterparty can live in, with the tax data it needs. Ordered by `id`. Never paged. Needs `counterparties:read` or `counterparties:write`.