Skip to navigation

Confirmar la entrega de una reserva de pago

Confirma que el comprador recibió su pedido y libera su reserva de pago: el dinero pasa a tu balance y se envía el webhook payment_hold.released. Úsalo desde la app del repartidor al escanear el QR del comprador, o con el código de 6 dígitos que el comprador dicta. code acepta el contenido del QR o el código; nunca lo devolvemos en la API ni en los webhooks, porque prueba que el repartidor estuvo frente al comprador. Después de 10 códigos incorrectos la reserva ya no acepta ninguno. Repetir la llamada sobre una reserva ya liberada responde 200 con el mismo checkout. En un Sandbox funciona igual, sin mover dinero real.

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

checkout_idstringRequired

Headers

X-ACCOUNT-IDstringOptional

ID de una cuenta hija conectada. Ejecuta el request dentro de esa cuenta, como Stripe-Account en Stripe Connect. La plataforma puede acceder a todos los recursos API que pertenecen a la hija, sin filtrar por creador. Solo aplica a hijas directas: si la cuenta no está conectada a la tuya, el request responde 404 con code: connected_account_not_found.

Con una llave de organización este header nombra la cuenta miembro sobre la que quieres operar; si no pertenece a la organización, el request responde 404 con code: organization_account_not_found. En una lectura puedes omitirlo para abarcar todas las cuentas de la organización.

Request

This endpoint expects an object.
codestringRequired

El contenido del QR del comprador, o el código de 6 dígitos que muestra debajo (con o sin espacios).

Response

Entrega confirmada; payment_hold.status es released.

idstring

ID único del checkout

statusenum
Estado del checkout
Allowed values:
itemslist of objects

Colección completa de filas mutables del checkout. No incluye descuentos, envío, fees ni prorrateos derivados.

bank_transfer_memostring or nullOptional

Referencia normalizada propuesta por la integración. Es null cuando Recurrente generará la referencia al iniciar el pago por transferencia.

total_in_centsintegerOptional

Monto total en centavos (después de descuentos)

subtotal_in_centsintegerOptional

Monto subtotal en centavos, antes de descuentos: el del cupón (discount) y el propio de cada item (items[].discount_in_cents).

discountobject or nullOptional

Descuento aplicado al checkout (null si no hay descuento)

currencyenumOptional
Moneda del checkout
Allowed values:
payment_method_typeslist of enumsOptional

Métodos de pago que se le ofrecerán al comprador en este checkout, ya resueltos según la configuración del producto/cuenta, la moneda y el tipo de cobro: card (tarjeta, pago de contado), bank_transfer (transferencia bancaria), stablecoins (dólares digitales), balance (Balance Recurrente), akisi (efectivo en Akisí; solo cuentas habilitadas, cobros únicos en GTQ con precio fijo y cuentas fuera de Sandbox). Las cuotas se exponen por separado en available_installments; card indica pago de contado, así que un checkout puede ofrecer cuotas (available_installments no vacío) sin incluir card.

Allowed values:
available_installmentslist of integersOptional

Opciones de cuotas (en meses) disponibles en este checkout, independientes de payment_method_types. Vacío si no se ofrecen cuotas.

live_modebooleanOptional

Si el checkout está en modo producción (true) o prueba (false). En Sandbox siempre es false, incluso si se creó desde un enlace de tienda o de pago.

amount_set_in_browserbooleanOptional

El monto lo fijó el navegador del comprador. Solo en checkouts creados por el botón de Clave en el sitio del comercio, con ítems con monto inline y sin firma del servidor. Compáralo con tu pedido antes de entregar.

clave_enabledbooleanOptional

Si el checkout ofrece Clave (tarjetas guardadas del comprador). false cuando se creó con clave_enabled en false.

payment_holdobject or nullOptional

Reserva de pago del checkout. null cuando el checkout se creó sin payment_hold.

success_urlstringOptional

URL de redirección en caso de pago exitoso

cancel_urlstringOptional

URL de redirección en caso de cancelación

expires_atdatetimeOptional

Fecha de expiración del checkout

created_atdatetimeOptional

Fecha de creación

metadatastring or double or booleanOptional
Metadata personalizada del checkout
custom_fieldslist of objectsOptional

Valores recolectados de los campos personalizados. Si el checkout tiene múltiples productos, cada producto contribuye sus propias entradas — la key puede repetirse entre productos. Usa field_id como identificador canónico al reconciliar valores.

transfer_setupslist of objectsOptional
Configuraciones de transferencia asociadas
application_fee_amountinteger or nullOptional

Comisión de plataforma en centavos (pagos únicos): la suma de las transferencias de comisión del checkout. null cuando no hay comisión.

application_fee_percentdouble or nullOptional

Comisión de plataforma como porcentaje del total de cada factura (suscripciones). null cuando no hay comisión.

latest_intentobject or nullOptional

Último intent unificado asociado. Su id usa el prefijo in_….

paymentobject or nullOptional

Información del pago (si está pagado)

payment_methodobject or nullOptional

Método de pago utilizado

Errors

404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error