»
Payment DELETE API Documentation
Delete Payment by ID : /payments/{payment_id}
DELETE
https://dev-api.exsited.com/api/v3/payments/{payment_id}
Try It Out
Purpose
This API endpoint delete a specific payment record from the system using its unique payment ID. It permanently removes the payment entry and disassociates it from any linked invoice or sale order.
Use Case
The API is used when a payment has been added in error or needs to be removed due to reconciliation issues, duplicate entries, or corrections. This is typically executed by financial administrators or automated systems ensuring the accuracy of financial records.
Path Parameters
Parameter | Type | Description |
---|---|---|
payment_id | String | Unique ID of the payment . |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response is empty, but the HTTP status code returned is 204 No Content
, indicating that the payment has been successfully deleted with no further content returned in the body.