Proceed with payment via checkout session

Processes a payment using an existing checkout session. Requires the payment initiator ID and session details.

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

The ID of the payment initiator

integer
required

The payment amount in the smallest currency unit (e.g., pence for GBP)

const
enum
required

The currency code

Allowed:
uri
required

URL to redirect the user after successful payment

uri
required

URL to redirect the user after failed payment

uri
required

URL to redirect the user after cancelled payment

string | null

External reference for the payment

metadata
object

Custom metadata for the payment (max 10 key-value pairs, keys 1-30 chars, values 1-200 chars)

shippingAddress
object

Address with all fields optional

billingAddress
object

Address with all fields optional

lineItems
array of objects | null

Array of line items, each being either airline, car rental, lodging, or product data

lineItems
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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