Skip to main content

Delete SMS Payment Receipt (v1)

Method & Path

DELETE /api/v1/workspace/:workspaceId/sms/payments/:paymentId/receipt-image

Description

Delete the receipt image for an SMS payment record.

Authentication

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with workspace permissions.

Headers

Authorization: Bearer <workspace_token>
Content-Type: application/json

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
paymentIdstringYesPayment identifier

Response 200 OK

{
"id": "507f1f77bcf86cd799439011",
"workspaceId": "507f1f77bcf86cd799439012",
"amount": 50.00,
"paymentMethod": "bank-transfer",
"receiptImage": null,
"updatedAt": "2025-01-15T11:00:00.000Z"
}

Common Errors

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have permission to delete receipts

404 Not Found: Workspace or payment not found

500 Internal Server Error: Server error occurred while processing the request

Notes

  • This operation is permanent and cannot be undone
  • Image file is deleted from storage
  • Storage quota is updated after deletion