Skip to main content
GET
Get a Hosted Checkout session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Response

The checkout session for the authenticated tenant and environment.

id
string<uuid>
required
object
any
required
public_reference
string
required
Pattern: ^spcs_[a-z0-9]{32}$
url
string<uri>
required
Pattern: ^https://checkout\.simplepay\.mx/checkout/spcs_[a-z0-9]{32}$
status
enum<string>
required
Available options:
open,
canceling,
completed,
expired,
canceled
amount_source
enum<string>
required
Available options:
manual_amount,
catalog_line_item
manual_amount
integer | null
required
Required range: 1 <= x <= 9007199254740991
currency
string
required
Pattern: ^[a-z]{3}$
catalog_line_item_snapshot
object | null
required
payment_method_types
enum<string>[]
required
Minimum array length: 1
Available options:
card,
oxxo,
spei
installment_options
object[]
required

Canonical installment terms offered by the resource; empty when installments are not offered.

Maximum array length: 6
installment_plan
object | null
required

One SimplePay card-installment term. The merchant offers terms at resource creation; the buyer may only select one offered term at quote/pay.

source_product
enum<string> | null
required
Available options:
payment_links,
null
source_id
string | null
required
source_public_id
string | null
required
Pattern: ^splink_[a-z0-9]{32}$
expires_at
string<date-time> | null
required
metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
installment_pricing
object

Merchant-owned financing choice applied consistently to every offered term. absorb forbids buyer markup; pass_to_buyer may include a governed markup in basis points.

Last modified on September 1, 2026