deleteLink
Delete an unused payment link. Only links that have not yet been paid can be deleted.
Request
| Header |
Required |
Description |
token |
Yes |
Your API Key |
Content-Type |
Yes |
application/json |
Body Parameters
| Field |
Type |
Required |
Description |
link_id |
integer |
Yes |
The linktopay_id of the link to delete |
Response
Success (ResponseCode: 1)
{
"ResponseCode": 1,
"ResponseMsg": "Link has been deleted successfully",
"Result": "True",
"ServerTime": "CEST"
}
Error (ResponseCode: 0)
{
"ResponseCode": 0,
"ResponseMsg": "Invalid link ID",
"Result": "False",
"ServerTime": "CEST"
}
| ResponseMsg |
Cause |
This link is already used |
Cannot delete a paid link |
Invalid link ID |
Link not found or belongs to another user |
Please enter link_id |
Missing link_id field |
Examples
Notes
- Only
Unused links can be deleted
- Deletion is permanent — the link URL will return a 404
- No webhook is sent when a link is deleted
- You can only delete links that belong to your account