API
Checking Raims account

Update a payment link

Pause or reactivate the link and update its return URLs and payment methods.

PATCHhttps://api.raims.com/v1/payment_links/{id}

Updates an existing link's configuration. Use is_active: false to pause the checkout and is_active: true to reactivate it with the same URL. Omitting this field keeps the configuration; null is not accepted. Pausing also prevents new requests to email the link. It does not cancel Pix or boleto already issued or extend the charge's due date.

You can also send return URLs and the list of methods accepted in the checkout. URLs that are omitted, null or empty keep the registered addresses. To remove a destination, send clear_success_redirect_url: true or clear_cancel_redirect_url: true. Sending false or omitting the command does not request removal.

Do not send a populated URL together with its clearing command set to true. This combination returns HTTP 400, with MUTUALLY_EXCLUSIVE in the details of both fields. You can remove one destination and update the other in the same request. The response shows null for the removed destination.

The linked charge must be open and within its due date, including when pausing or reactivating. Other changes do not reactivate a paused link.

Omitting payment_method_types keeps the link's configuration. Sending null removes this custom configuration and returns to the methods defined by the charge and the account's checkout.

The request keeps the link to the charge and does not change the customer, title, amount, due date or status. To look up or edit the allowed charge data, use the charges reference. See Configure the link to understand return URLs and payment method restrictions.

Path Params

Public link identifier received when creating or listing links.

Up to 100 characters

Body Params

Send false to pause checkout and true to reactivate the same URL. Omitting it keeps the current state. Pausing does not cancel issued Pix or boleto or extend the due date.

false

HTTPS return URL after confirmed payment. Omitting it, sending null or empty text keeps the existing URL. To remove it, use clear_success_redirect_url with true without providing a populated 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. To remove it, use clear_cancel_redirect_url with true without providing a populated URL.

Up to 2048 characters

Send true to remove the return destination after payment. False or omission does not request removal. Do not send true together with a populated success_redirect_url.

true

Send true to remove the destination for returning to the website. False or omission does not request removal. Do not send true together with a populated cancel_redirect_url.

true

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

1 - Pix

Responses

For common errors, see HTTP response codes.