Skip to main content
GET
Retrieve a checkout session

Authorizations

Authorization
string
header
required

API key from the Payoes dashboard (pk_test_... or pk_live_...)

Path Parameters

id
string
required

Public checkout session ID

Example:

"cs_abc123xyz"

Response

Checkout session details

id
string
required
Example:

"cs_abc123xyz"

object
enum<string>
required
Available options:
checkout.session
status
enum<string>
required
Available options:
open,
complete,
expired
checkout_url
string<uri>
required
created_at
string<date-time>
required
payment_intent_id
string | null
amount
string | null
settlement_asset
object | null
allowed_assets
object[]
paid_asset
object | null
payment_status
enum<string>
Available options:
pending,
completed,
failed,
expired
customer_id
string | null
success_url
string<uri> | null
cancel_url
string<uri> | null
expires_at
string<date-time> | null