Skip to navigation
Referencia APITerminal Session Commands

Cancelar un comando de terminal

Solicita la cancelación de forma idempotente. Un comando pending pasa directamente a canceled y responde 200. Si la terminal ya lo tomó, responde 202 con cancel_requested; la terminal detiene la lectura y confirma canceled cuando el dispositivo reporta la cancelación.

Durante una autorización no se confirma la cancelación: el comando permanece en cancel_requested hasta resolver como canceled, consumed o failed. Consulta el comando hasta que final sea true. Esta separación evita declarar cancelado un pago que ya pudo llegar al procesador.

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

random_idstringRequired

Response

Cancelación confirmada o ya confirmada

idstringOptional

ID público aleatorio del comando

external_idstringOptional

ID único de tu sistema dentro de la cuenta autenticada

statusenumOptional
Estado del comando
finalbooleanOptional

true cuando el comando alcanzó un resultado definitivo y ya no puede cambiar

terminal_idstringOptional
ID de la terminal POS
amount_in_centsintegerOptional

Monto en centavos. Para un cobro con items, la suma de los items.

currencyenumOptional
Moneda del cobro
Allowed values:
installmentsinteger or nullOptional

Meses sin intereses solicitados, o null si el cobro va sin cuotas

descriptionstring or nullOptional

Concepto del cobro enviado al crear el comando, o null si no se envió uno

show_post_payment_screensbooleanOptional

Indica si el comando solicita mostrar las pantallas post-pago de NIT, correo y teléfono

print_receiptbooleanOptional

Indica si el comando solicita imprimir automáticamente el comprobante de pago

tax_idstring or nullOptional

NIT del comprador enviado con el cobro, o null si no se envió uno

terminal_availabilityenumOptional
Disponibilidad observada de la terminal para recibir comandos
Allowed values:
checkout_idstringOptional
ID del checkout generado
checkout_urlstringOptionalformat: "uri"

URL del checkout (la terminal usa esta URL internamente)

checkout_statusenumOptional
Estado actual del checkout asociado
cancellation_requested_atdatetime or nullOptional

Momento en que se solicitó detener un comando ya despachado

canceled_atdatetime or nullOptional

Momento en que la cancelación se volvió definitiva

Errors

404
Not Found Error
409
Conflict Error