Hacer check-out

POST

https://app.recurrente.com/api/stays/:stay_id/check_out

POST

/api/stays/:stay_id/check_out

curl -X POST https://app.recurrente.com/api/stays/stay_id/check_out \
     -H "X-SECRET-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "booking": {
    "id": "bk_9f8e7d6c",
    "account_id": "ac_4b3a2c1d",
    "status": "completed",
    "source": "storefront",
    "starts_at": "2024-01-15T14:00:00Z",
    "ends_at": "2024-01-17T11:00:00Z",
    "customer": {
      "id": "cus_7a6b5c4d",
      "name": "Carlos Martínez",
      "email": "carlos.martinez@example.com",
      "phone": "+502 5555 1234"
    },
    "segments": [
      {
        "service_id": "svc_1234abcd",
        "product_id": "prd_5678efgh",
        "product_variant_id": "var_9abcde01",
        "staff_member_id": "stf_2345bcde",
        "resource_id": "res_6789fabc",
        "kind": "service",
        "starts_at": "2024-01-15T14:00:00Z",
        "ends_at": "2024-01-15T15:00:00Z"
      }
    ],
    "staff_member_id": "stf_2345bcde",
    "resource_id": "res_6789fabc",
    "class_session_id": "cls_3456cdef",
    "stay": {
      "room_type_id": "svc_ab12cd34",
      "unit_id": "res_ab12cd34",
      "unit_name": "Cabaña 1",
      "check_in_on": "2024-01-15",
      "check_out_on": "2024-01-17",
      "nights": 2,
      "guests": 2,
      "service_tab_id": "tab_7890abcd",
      "registered_guests": [
        {
          "name": "Lucía Pérez",
          "document": "DPI 1234 56789 0101",
          "nationality": "Guatemalteca"
        }
      ],
      "guests_registered_at": "2024-01-15T13:45:00Z"
    },
    "payment_policy": "full",
    "currency": "GTQ",
    "total_in_cents": 20000,
    "paid_in_cents": 15000,
    "balance_in_cents": 5000,
    "balance_paid_outside_at": "2024-01-17T10:30:00Z",
    "checkout_id": "chk_4567defg",
    "checkout_url": "https://app.recurrente.com/payments/checkout/chk_4567defg",
    "balance_checkout_id": "bal_8901ghij",
    "balance_checkout_url": "https://app.recurrente.com/payments/balance/bal_8901ghij",
    "no_show_fee_checkout_id": "nsf_2345ijkl",
    "booking_series_id": "ser_6789mnop",
    "access_url": "https://app.recurrente.com/bookings/access/bk_9f8e7d6c",
    "customer_note": "Prefiere habitación con vista al lago.",
    "merchant_note": "Cliente frecuente, aplicar descuento de fidelidad.",
    "accepted_at": "2023-12-20T08:00:00Z",
    "hold_expires_at": "2023-12-25T23:59:59Z",
    "cancelled_by": "merchant",
    "cancellation_reason": "Cambio de planes del cliente",
    "rescheduled_from_id": "bk_8e7d6c5b",
    "metadata": {},
    "created_at": "2023-12-15T10:00:00Z"
  },
  "closing": {
    "type": "checkout",
    "id": "chk_4567defg",
    "status": "paid",
    "url": "https://app.recurrente.com/payments/checkout/chk_4567defg"
  }
}

El huésped se va: lo que la estadía todavía debe se suma a su cuenta abierta y la cuenta se cierra según channel: saved_card la cobra a la tarjeta que dejó, pos manda la orden al punto de venta y payment_link (por defecto) responde un link para pagar. La estadía queda completed y la habitación libre. Emite booking.check_out. Requiere que la llave pueda mover dinero.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

stay_idstringRequired

Request

This endpoint expects an object.

channelenumOptionalDefaults to payment_link

Allowed values:

Response

Check-out hecho

bookingobjectOptional

closingobject or nullOptional

Lo que cerró la cuenta abierta; null si no quedó nada por cobrar.

Errors

403

Forbidden Error

422

Unprocessable Entity Error