Create a checkout session

Creates a hosted checkout session for the total of the supplied line items and returns its URL. Payment-method saving is enabled by default and requires a customer email; set enablePaymentMethodSave to false to opt out.

Authorization

basic

AuthorizationBasic <token>

Basic HTTP authentication

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

lineItems*array<>

Items1 <= items

successUrl*string

URL Stripe redirects to after successful payment. May contain {CHECKOUT_SESSION_ID} placeholder.

cancelUrl*string

URL Stripe redirects to if the customer cancels.

customerEmail?string

Required unless enablePaymentMethodSave is explicitly false. When the save flag is on (its default), the gateway keys the customer's saved payment method on (merchant, email), so an email is mandatory.

Formatemail

enablePaymentMethodSave?boolean

When true, the payment method is saved for future prefill on sessions with the same customerEmail. By sending this flag as true, the merchant attests that they obtained and recorded the customer's consent to having their payment method saved by Highwire for future use. Send false to opt out for this session — in which case customerEmail also becomes optional.

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/v1/payments/checkout-session" \  -H "Content-Type: application/json" \  -d '{    "lineItems": [      {        "name": "Test Widget",        "amount": 2000,        "quantity": 1      }    ],    "successUrl": "https://merchant.example.com/success?session_id={CHECKOUT_SESSION_ID}",    "cancelUrl": "https://merchant.example.com/cancel"  }'

{  "paymentId": "01928e3e-7b6c-7c8e-9b3a-5b9f8b9b9b9b",  "status": "PENDING",  "amount": 7200,  "sessionId": "cs_test_a1B2c3D4",  "sessionUrl": "https://checkout.stripe.com/c/pay/cs_test_a1B2c3D4",  "customerId": "01928e3e-7b6c-7c8e-9b3a-5b9f8b9b9bcc",  "paymentMethodId": "01928e3e-7b6c-7c8e-9b3a-5b9f8b9b9bff"}

{  "statusCode": 400,  "error": "Bad Request",  "message": [    "amount must not be less than 100"  ]}

{  "statusCode": 401,  "error": "Unauthorized",  "message": "Missing Authorization header"}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`