Skip to main content
POST
Create Payment Session

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Body

application/json
amount
integer
required
Required range: x >= 1
currency
string
required
Required string length: 3
external_id
string
customer
object
capture_method
enum<string>
default:automatic
Available options:
automatic,
manual
payment_method_types
enum<string>[]
Available options:
card,
apple_pay,
google_pay,
bank_account,
paypal
success_url
string<uri>
cancel_url
string<uri>
metadata
object

Response

Session created successfully

id
string<uuid>
client_secret
string
status
enum<string>
Available options:
requires_payment_method,
requires_action,
processing,
succeeded,
failed,
canceled
amount
integer
currency
string
external_id
string
fallback_url
string<uri>
created_at
string<date-time>