Skip to main content
POST
Create checkout

Overview

Create a hosted checkout session for a customer. This endpoint returns a checkout ID and checkout URL that you can use to redirect the customer and complete payment.

Authorizations

X-API-KEY
string
header
required

API key for authentication.

Body

application/json
email
string<email>
required
amount
number
required
currency
string
required
payment_options
object[]
required

Optional. The ways the payer may pay. Omit it to offer every method that is live for the currency (recommended). Methods not live for the currency are left off the page even if listed.

Response

Checkout initiated successfully

status
boolean
data
object
error
any[]
message
string