<- Checkout API

Checkout API

Update payment link

PUT

 /v2/online-checkout/payment-links/{id}

Updates a payment link.

You can update the payment_link fields such as description, checkout_options, and pre_populated_data. You cannot update other fields such as the order_id, version, URL, or timestamp field.

Permissions:ORDERS_READ, ORDERS_WRITE, PAYMENTS_WRITE

Guide

Update a payment link

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

id

string

Required

The ID of the payment link to update.

Link to section

Request body

Link to section

payment_link

Required

The payment_link object describing the updates to apply. For more information, see Update a payment link.

Link to section

Response fields

Link to section

errors

Any errors that occurred when updating the payment link.

Link to section

payment_link

The updated payment link.

Error descriptions