Create a checkout session

POST

/checkout/sessions

• Production

Fixes amount and currency server-side and returns the hosted URL the customer is sent to. The processor credential TTL does NOT start here, it starts when the customer lands and the page acquires credentials.

Authorizations

• secret_key

Request Body^required

object

amount

required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64

Example

1000

currency

required

Currently supported currencies by Paygasus Pay

string

Allowed values: USD

Example

USD

Responses

201

Checkout session created

object

amount

required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64

Example

1000

created

required

integer format: int64

currency

required

Currently supported currencies by Paygasus Pay

string

Allowed values: USD

Example

USD

id

required

string

livemode

required

boolean

object

required

string

payment_intent_id

One of:

null

null

string

Set once confirm has run: the payment intent the charge is correlated to, and its current status (committed = approved; failed = decline).

string

Example

pi_card_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

payment_status

One of:

null

null

string

string

Allowed values: created authorized committed failed canceled

status

required

string

Allowed values: created opened completed expired

status_detail

string | null

url

required

The Paygasus-hosted page for this session — where the merchant sends the customer.

string

400

Invalid request

object

error

required

object

code

required

string

message

required

string

param

string | null

type

required

string