Update Checkout Session

Updates the details of a specific checkout session using the provided session ID. This call allows merchants to modify session attributes such as the redirect URL, payer's name, and email address. It is particularly useful for correcting information or updating session details before the payment process is completed.

Path parameters

sessionIdstringRequired
Unique identifier for the checkout session.

Request

This endpoint expects an object.
redirectUrlstringOptional
Updated URL to redirect after payment.
payerNamestringOptional
Updated full name of the payer.
payerEmailAddressstringOptional
Updated email address of the payer.

Response

Checkout session updated successfully.
sessionIdstring or null
Unique identifier for the session.

Errors