Counterparties
Delete Counterparty
Soft-delete a counterparty. The counterparty will be marked as deleted but not permanently removed from the system. Deleting moves no money, so a counterparty that still holds a balance cannot be deleted — pay the remaining balance out first.
delete/api/v1/counterparties/:counterpartyId
Request
- Base URLhttps://merchant-api.accruesavings.com
- Authnone declared. Required headers: Client-ID, Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
counterpartyIdstring uuid required
ID of the counterparty to delete.
Example:123e4567-e89b-12d3-a456-426614174000
Headers
Client-IDstring uuid required
The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required
Secure secret to access privileged endpoints.
Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef
Response
Counterparty deleted successfully (no content)
Changes
No recorded changes to this operation across all 1 revision of this API.