The Checkout API (see Checkout API Overview)
provides endpoints to manage the checkout pages you created. You can update, retrieve, or delete the checkout pages.
Link to section
Update a payment link
You can use the UpdatePaymentLink endpoint to update the following payment_link fields.
description.
checkout_options. You should specify the entire CheckoutOptions object in the update request.
If you specify only specific fields, the update operation deletes fields not included in the request.
pre_populated_data. You only specify the PrePopulatedData fields that you want to update (or add). If a field you provided in the request does not exist, it gets added.
You cannot update the order_id, version, URL, or timestamp fields.
In the following example, you create a checkout page and then call UpdatePaymentLink to apply the updates.
Create a quick pay checkout page for $125 for auto detailing:
Note that fields_to_clear is an array where you provide a comma-separated list of fields to delete. For example:
This deletes the allow_tipping field from checkout_options and the entire buyer_address from pre_populated_data. To delete the entire checkout_options, specify the following:
Link to section
Retrieve payment links
You can retrieve a specific payment link by ID or all the payment links in the account. The Checkout API provides the RetrievePaymentLinks and ListPaymentLinks endpoints. Try using API Explorer to test these endpoints.
Link to section
Delete a payment link
You can use the DeletePaymentLinks endpoint to delete a payment link you created.