Skip to main content
POST
Create a hosted Checkout Session

Uso

Usalo para crear o consultar checkouts hospedados. La confirmacion operativa debe venir de webhooks o de una lectura de API, no del redirect.

Antes de llamar

Patron recomendado

  • Ejecuta este endpoint desde backend o job seguro, nunca desde frontend con API keys.
  • Manda Idempotency-Key cuando el endpoint cree, convierta, reprograme, cancele, capture o reembolse estado.
  • Persiste IDs SimplePay (spcs_..., sppi_..., splink_..., refund IDs o booking IDs) para reconciliacion.
  • Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.

Ejemplo minimo

terminal

Errores a manejar

  • 400 indica payload, parametros o estado invalido.
  • 401 o 403 indican API key, ambiente o scopes incorrectos.
  • 409 suele indicar conflicto de estado, duplicado o idempotencia incompatible.
  • 429 y 5xx se pueden reintentar con backoff; en writes conserva la misma idempotency key.

Contrato OpenAPI

El playground, parametros, body y respuestas de abajo salen de /openapi.json. Si el contrato cambia, actualiza la spec y regenera esta pagina.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required
Required string length: 8 - 255

Body

application/json
currency
string
required
Pattern: ^[a-z]{3}$
line_items
object[]
required
Minimum array length: 1
success_url
string<uri>
required
appearance
object
cancel_url
string<uri>
client_reference_id
string
Maximum string length: 255
customer
object
customer_email
string<email>
installments
object
metadata
object
payment_method_types
enum<string>[]
Minimum array length: 1
Available options:
card,
oxxo,
spei
pricing
object

Response

200 - application/json

Checkout Session created

amount_total
integer
id
string
Pattern: ^spcs_[a-z0-9]{32}$
object
any
pricing_snapshot
object
status
string
url
string<uri>
Example:

"https://checkout.simplepay.mx/checkout/spcs_0123456789abcdef0123456789abcdef"

Last modified on July 8, 2026