Invalidating PayLinks

Learn how to invalidate a PayLink

Overview

An invalid PayLink will no longer display the option for customers to submit payments when they view the order payment site. Instead, the site will display an error message that explains the link is canceled or expired.

You are able to directly control link invalidation in a couple ways:

  • You can set an expiration date and time, which will automatically expire your PayLink after the date and time have passed.
  • You can send an API call to Skipify to cancel a previously created PayLink.

Invalidating via the expiration field:

When creating a PayLink, you can set a specific datetime for when the link expires. After that datetime, the link will become invalid and the status of the PayLink will be "Expired."

API Request

πŸ‘

This endpoint uses HMAC

Check out our API Authentication section to learn more

The endpoint for this request uses the payment's paylinkId, which was originally provided in the response body when you created the PayLink. To invalidate a PayLink, send an API call to:

PATCH https://paylinks.skipify.com/{paylinkId}/cancel

API Response

CodeDescription
204Successfully canceled a PayLink
400Invalid cancel request
404PayLink was not found

πŸ‘

API Reference

Check out our API Reference to learn more



Skipify baner with link to contact us form