Get Checkout Session

Overview

Get the checkout session of a given payment request. Available for Client tokens.

Authentication

This endpoint is designed for client checkout flows and may also work without authentication for public checkout scenarios.

Coupon Functionality

The optional coupon_code parameter applies a discount to the payment request. Note: Business must have rollout.payments.coupons_checkout_v2 feature enabled and active coupons available. Returns 422 error if business is not eligible for coupon functionality.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Payment Request UID

Query Params
string

Optional coupon code to apply discount to the payment request

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json