Modify attributes of an existing payment link or reactivate a previously deactivated link.
This endpoint allows merchants to keep their payment links up-to-date or restore inactive links for reuse.
Key Features
- Update attributes of an existing payment link, such as amount, expiration, or metadata.
- Deactivate a payment link by setting the
activeparameter tofalseor0. - Reactivate a payment link by updating the
activeparameter totrueor1.
Usage Notes
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.
Response Structure
| 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 | Unexpected server error occurred. |
Important Considerations
ID Requirement: Ensure that the id or link_meta.paymentLinkId of the payment link is provided in the request.
Preserving 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.