Modify attributes of an existing payment link or reactivate a previously deactivated link.
This endpoint enables merchants to update their payment links or restore inactive links for reuse.
Key Features
Modify existing payment link properties such as amount, expiration date, or metadata.
Set the active parameter to false or 0 to make links inaccessible without permanent deletion.
Restore previously deactivated links by setting the active parameter to true or 1.
Documentation
Parameters
Accepts the same parameters as the Create a Payment Link endpoint, except for the funding parameter, which is unsupported in this context.
Requires the id or link_meta.paymentLinkId route parameter to identify the specific link to update.
Deactivating Links
To deactivate a link, set the active parameter to false or 0. This makes the link inaccessible without deleting it permanently.
Reactivating Links
To reactivate a deactivated link, set the active parameter to true or 1.
| Code | Response | Reason |
|---|---|---|
| 200 | Success | The payment link was successfully updated or reactivated. |
| 400 | Bad Request | Missing required parameters or invalid input. |
| 401 | Unauthorized | Authentication failed. |
| 404 | Not Found | The specified payment link ID does not exist. |
| 500 | Internal Server Error | An unexpected server error occurred. |
ID Requirement
Ensure that the id or link_meta.paymentLinkId of the payment link is provided in the request.
Data Integrity
Double-check any updates to avoid unintentional changes, particularly when modifying metadata or amounts.
Unsupported Parameter
The funding parameter is not supported when updating payment links.
Making any change to a payment link will alter the URL. After making a change, you will need to use the new payment link URL and update any reference to use the new updated URL.
Note: This does not apply to deactivating or reactivating a payment link.