Delete a Counterparty
Removes a counterparty, so it is no longer listed and cannot be withdrawn to. Refused while a withdrawal to it is still open. The record is kept, so the withdrawals that named it still find it, and saving the same destination again brings it back with the same id.
Part of crypto v3, in beta. While crypto v3 counterparties are off for the account, this answers 404 feature_not_enabled.
An account-scoped key deletes only its own account's counterparties; another account's reads as 404. A workspace-scoped key deletes any counterparty of the workspace.
Replaces DELETE /api/v2/crypto/beneficiaries/{id}.
Authorization:
Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.
Headers:
Authorization: APIKey {SIGNED_JWT}
How to build and sign the JWT: Authentication.
Endpoint
/v3/crypto/counterparties/{counterparty_id}
Path parameters
| Parameter | Type | Description |
|---|---|---|
counterparty_id | string (wlt_…) | Required. The counterparty. |
Response
204 No Content. It also sends the crypto_beneficiary_deleted webhook.
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | counterparty_id is not a wlt_… id. |
400 | invalid_account_id | A workspace-scoped key sent an account_id query parameter (see Turning it on) that is not a cst_… id. |
401 | unauthorized | Missing or invalid signature. |
404 | feature_not_enabled | Crypto v3 counterparties are not enabled. See Turning it on. |
404 | counterparty_not_found | No such counterparty, it was already deleted, it belongs to another account, or the id is a deposit wallet's. |
409 | counterparty_in_use | A withdrawal to it is still open (not yet completed, failed or cancelled). |
Coming from v2
v2 deletes a beneficiary even while a withdrawal to it is open; v3 refuses with 409 counterparty_in_use.
Support and Resources
If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.
Stay Updated
Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!