This function deletes a payment-method of a customer.
Soft-delete a payment method, making it inaccessible for future transactions. The payment method is not permanently deleted but is marked as deleted by setting the deleted_at timestamp.
Key Features
- Marks a payment method as inactive by updating the
deleted_attimestamp. - Retains the record in the database for compliance and reporting.
- Soft-deleted payment methods can be reactivated using the Update a Payment Method endpoint.
Usage Notes
Soft Deletion: The payment method is not permanently erased but is marked as deleted.
Future Transactions: Deleted payment methods cannot be used for future transactions.
Automatic Deletion: Payment methods not used for over six months may be automatically deleted.
Response Structure
| Code | Response | Reason |
|---|---|---|
| 200 | Success | Returns a confirmation message indicating the payment method has been deleted. |
| 400 | Bad Request | Invalid payment method ID. |
| 401 | Unauthorized | Authentication failed. |
| 404 | Not Found | Payment method does not exist. |
| 500 | Internal Server Error | An unexpected error occurred on the server. |
Important Considerations
Data Retention Policies: Be aware of any policies regarding data retention and deletion.
Customer Consent: Ensure you have authorization to delete a customer's payment method.
Reactivation: Soft-deleted payment methods can be reactivated if necessary.