Update a counterparty
/api/v2/counterparties/{id}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.
Path Parameters
The counterparty id (counterparty_…) or your customId.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v2/counterparties/counterparty_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e" \ -H "Content-Type: application/json" \ -d '{}'{ "object": "counterparty", "id": "counterparty_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e", "customId": "campaign-42", "identity": { "type": "individual", "firstName": "string", "lastName": "string" }, "email": "jane@example.com", "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "postalCode": "string", "country": "DE" }, "paymentMethod": { "type": "bank_iban", "iban": "string", "currency": "string" }, "taxIdentity": { "taxId": "string", "vatNumber": "string", "dateOfBirth": "2026-10-01", "birthPlaceCity": "string", "birthPlaceCountry": "DE", "registrationNumber": "string" }, "recipientManaged": true, "missing": [ "address" ], "createdAt": "2026-09-24T10:00:00.000Z", "updatedAt": "2026-09-24T10:00:00.000Z"}Get a counterparty GET
`{id}` is the counterparty id or your `customId`. Needs `counterparties:read`.
Delete a counterparty DELETE
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`.