Skip to main content
POST
Create a checkout session

Body

application/json
product
string
required
Required string length: 1 - 120
amount
number
required
Required range: x <= 10000
customer
string<email>
required
preferredRoute
enum<string>
Available options:
card,
wallet,
local
redirectUrl
string<uri>
metadata
object
environment
enum<string>
default:sandbox
Available options:
sandbox,
production
idempotencyKey
string
Required string length: 8 - 120
clientReferenceId
string
Required string length: 3 - 120

Response

Checkout session created

id
string
required

Checkout session ID with chk_* prefix.

object
enum<string>
required
Available options:
checkout_session
checkoutUrl
string<uri>
required
status
enum<string>
required
Available options:
routed,
pending,
paid,
failed,
expired
amount
number
required
currency
string
required
redirectUrl
string<uri>
customer
string<email>
metadata
object
environment
enum<string>
default:sandbox
Available options:
sandbox,
production