Create a payment link
Create or retrieve the payment link for an existing charge.
Creates or retrieves the link for a charge already registered in the company
and environment of your API key. In charge_id, provide the identifier of
the charge the customer should pay.
The charge must be open and within its due date to create or configure its link.
The link uses the customer, amount, due date and other charge data. While the charge allows this action, repeating the request reuses the existing link. You can configure return URLs and restrict the payment methods accepted in the checkout. Creating the link does not create another charge or request an email. A new link starts active. If the charge already has a paused link, this request keeps it paused; use PATCH to reactivate it.
See Payment links to understand the configuration fields and track payment through the linked charge.
Body Params
Existing charge identifier. The link uses that charge's customer, amount and due date.
Up to 100 characters
HTTPS return URL after confirmed payment. Omitting it, sending null or empty text keeps the existing URL.
Up to 2048 characters
HTTPS URL for returning to your website. This return does not cancel the charge. Omitting it, sending null or empty text keeps the existing URL.
Up to 2048 characters
Methods allowed in the link. Omitting it keeps the configuration; null removes the custom configuration. A list limits checkout methods and does not expand those allowed by the charge.
1 to 2 items
Responses
For common errors, see HTTP response codes.