Hold a booking slot and create a SimplePay Checkout Session
curl --request POST \
--url https://api.simplepay.mx/v1/bookable-payments/bookings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"event_type_id": "<string>",
"success_url": "<string>",
"event_type_slug": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 1
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
event_type_id: '<string>',
success_url: '<string>',
event_type_slug: '<string>',
product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 1
})
};
fetch('https://api.simplepay.mx/v1/bookable-payments/bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.simplepay.mx/v1/bookable-payments/bookings"
payload = {
"event_type_id": "<string>",
"success_url": "<string>",
"event_type_slug": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 1
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"booking": {
"ends_at": "2023-11-07T05:31:56Z",
"event_type_id": "<string>",
"hold_expires_at": "2023-11-07T05:31:56Z",
"hold_id": "<string>",
"id": "<string>",
"line_items": [
{
"amount_minor": 1,
"currency": "<string>",
"metadata": {},
"price_id": "<string>",
"product_id": "<string>",
"quantity": 2,
"title": "<string>"
}
],
"product_id": "<string>",
"quantity": 2,
"resource_id": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"status": "pending"
},
"checkout_session": {
"id": "<string>",
"url": "<string>"
}
}Hold a booking slot and create a SimplePay Checkout Session
Referencia detallada para POST /v1/bookable-payments/bookings.
POST
https://api.simplepay.mx
/
v1
/
bookable-payments
/
bookings
Hold a booking slot and create a SimplePay Checkout Session
curl --request POST \
--url https://api.simplepay.mx/v1/bookable-payments/bookings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"event_type_id": "<string>",
"success_url": "<string>",
"event_type_slug": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 1
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
event_type_id: '<string>',
success_url: '<string>',
event_type_slug: '<string>',
product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 1
})
};
fetch('https://api.simplepay.mx/v1/bookable-payments/bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.simplepay.mx/v1/bookable-payments/bookings"
payload = {
"event_type_id": "<string>",
"success_url": "<string>",
"event_type_slug": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 1
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"booking": {
"ends_at": "2023-11-07T05:31:56Z",
"event_type_id": "<string>",
"hold_expires_at": "2023-11-07T05:31:56Z",
"hold_id": "<string>",
"id": "<string>",
"line_items": [
{
"amount_minor": 1,
"currency": "<string>",
"metadata": {},
"price_id": "<string>",
"product_id": "<string>",
"quantity": 2,
"title": "<string>"
}
],
"product_id": "<string>",
"quantity": 2,
"resource_id": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"status": "pending"
},
"checkout_session": {
"id": "<string>",
"url": "<string>"
}
}Uso
Usalo dentro de Bookable Payments para modelar inventario reservado, calcular disponibilidad, crear holds, convertirlos en checkout y confirmar bookings.Antes de llamar
| Tema | Detalle |
|---|---|
| Metodo | POST |
| Ruta | /v1/bookable-payments/bookings |
| Auth | Bearer API key del ambiente correcto. |
| Scope | bookings:write |
| Idempotencia | Recomendada para cualquier retry. Usa una key deterministica por operacion de negocio. |
| Guia relacionada | Bookable Payments |
Patron recomendado
- Ejecuta este endpoint desde backend o job seguro, nunca desde frontend con API keys.
- Manda
Idempotency-Keycuando el endpoint cree, convierta, reprograme, cancele, capture o reembolse estado. - Confirma inventario final con
booking.confirmedo una lectura de booking, no solo con una URL de retorno. - Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.
Ejemplo minimo
terminal
curl -sS -X POST "https://api.simplepay.mx/v1/bookable-payments/bookings" \
-H "Authorization: Bearer $SIMPLEPAY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: create-booking-checkout_v1" \
-d '{ ... }'
Errores a manejar
400indica payload, parametros o estado invalido.401o403indican API key, ambiente o scopes incorrectos.409suele indicar conflicto de estado, duplicado o idempotencia incompatible.429y5xxse 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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required string length:
8 - 255Body
application/json
- Option 1
- Option 2
- Option 3
Required range:
x >= 1Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Hide child attributes
Hide child attributes
Required range:
x >= 0Pattern:
^[a-z]{3}$Minimum string length:
1Available options:
adult, child, guest, infant, resident, senior Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$Required range:
x >= 1Hide child attributes
Hide child attributes
Required range:
x >= 1Hide child attributes
Hide child attributes
Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$Hide child attributes
Hide child attributes
Required range:
x >= 0Pattern:
^[a-z]{3}$Minimum string length:
1Available options:
adult, child, guest, infant, resident, senior Hide child attributes
Hide child attributes
Available options:
adult, child, guest, infant, resident, senior Required range:
0 <= x <= 6Required range:
1 <= x <= 120Required range:
x >= 1Hide child attributes
Hide child attributes
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$Hide child attributes
Hide child attributes
Required range:
x >= 0Pattern:
^[a-z]{3}$Hide child attributes
Hide child attributes
Response
201 - application/json
Booking checkout created
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Required range:
x >= 0Pattern:
^[a-z]{3}$Available options:
add_on, deposit, fee, price, tax Required range:
x >= 1Required range:
x >= 1Available options:
pending Last modified on June 21, 2026
⌘I