Skip to navigation
Referencia APITerminal Batch Closes

Cerrar lote de terminal

Cierra el lote abierto actual de una terminal POS. Recurrente marca el lote como closed, calcula sus totales y deja la terminal lista para abrir un nuevo lote automáticamente con el próximo pago.

Este endpoint es útil para integraciones que controlan el POS desde un sistema externo y necesitan cerrar lote sin operar la pantalla de la terminal.

Envía Idempotency-Key para reintentos seguros: si tu sistema pierde la respuesta después de cerrar el lote, repetir el mismo request con la misma clave devuelve la respuesta original en vez de intentar cerrar otro lote.

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.

Headers

Idempotency-KeystringOptional

Clave de idempotencia para reintentos seguros de operaciones críticas, especialmente las que mueven dinero o cambian estado operativo. Reintentar con la misma clave y el mismo cuerpo devuelve la respuesta original (header Idempotency-Replayed: true); reusarla con parámetros distintos devuelve 409.

Request

This endpoint expects an object.
terminal_idstringRequired
ID de la terminal POS cuyo lote abierto quieres cerrar

Response

Lote cerrado exitosamente
idstringOptional
ID del lote cerrado
statusenumOptional
Estado del lote
Allowed values:
terminal_idstringOptional
ID de la terminal POS
transaction_countintegerOptional
Cantidad de transacciones exitosas incluidas en el lote
total_in_centsintegerOptional
Total agregado del lote en centavos
total_currencyenumOptional
Moneda principal del lote
Allowed values:
totals_by_currencymap from strings to integersOptional
Totales del lote agrupados por moneda
opened_atdatetimeOptional

Fecha y hora en que se abrió el lote

closed_atdatetime or nullOptional

Fecha y hora en que se cerró el lote

Errors

404
Not Found Error
422
Unprocessable Entity Error