Remove an existing payment link from your merchant account using its unique identifier.
This operation ensures that the payment link is no longer accessible to customers.
Key Features
- Permanently removes a payment link based on its unique ID.
- Prevents any further transactions or customer access through the deleted payment link.
- Provides clean-up functionality for outdated or unused payment links.
Usage Notes
Required Parameter: The id of the payment link to delete. This can be retrieved from the GET /query/payment-links or POST /query/payment-links endpoints.
Irretrievable Action: Deleting a payment link permanently removes it from active use. Ensure the correct id is provided to avoid accidental deletion.
Response Structure
| Code | Response | Reason |
|---|---|---|
| 200 | Success | The payment link was successfully deleted. |
| 400 | Bad Request | Invalid input or missing required parameters. |
| 401 | Unauthorized | Authentication failed. |
| 404 | Not Found | The specified payment link ID does not exist. |
| 500 | Internal Server Error | Unexpected server error occurred. |
Important Considerations
ID Retrieval: Use the GET /query/payment-links or POST /query/payment-links endpoints to fetch the id of the payment link you want to delete.
Final Action: Deletion is permanent and cannot be reversed. Double-check the payment link ID before proceeding.
Impact on Transactions: Any transactions tied to the deleted payment link will remain in the transaction history but cannot be processed further.