Customise redirect behaviour

You can customise how and whether Stripe redirects your customers after they complete payment. You can make Stripe always redirect customers or only redirect for some payment methods.

To set up redirects, specify the return page:

• In the return_url when you create the Checkout Session on your server
• In the returnUrl when you confirm the Checkout Session on the client.

Or you can redirect customers only if the payment method requires it (for example, a bank authorisation page for a debit-based method).

Redirect customers to a return page

When you create the Checkout Session, specify the URL of the return page in the return_url. You can add the {CHECKOUT_SESSION_ID} template variable to the return_url to include the ID of the completed Checkout Session. This is a literal string and you must add it exactly as you see here. Don’t substitute it with a Checkout Session ID, which happens automatically after your customer pays and is redirected to the return page.

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "line_items[0][price_data][currency]"=usd \
  -d "line_items[0][price_data][product_data][name]"=T-shirt \
  -d "line_items[0][price_data][unit_amount]"=2000 \
  -d "line_items[0][quantity]"=1 \
  -d mode=payment \
  -d ui_mode=custom \
  --data-urlencode return_url="https://example.com/return?session_id={CHECKOUT_SESSION_ID}"

Redirect-based payment methods

During payment, some payment methods redirect the customer to an intermediate page, such as a bank authorisation page. When they complete that page, Stripe redirects them to your return page.

To only redirect the customer to your return page if they’re redirected to an intermediate page, set redirect: 'if_required' when you confirm the Checkout Session.