RErecurrente
terminalSessionCommands

Cancelar un comando de terminal

Changed on

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.

delete/terminal_session_commands/{random_id}

Request

Path parameters

random_idstring required

Response

Cancelación confirmada o ya confirmada

idstring

ID público aleatorio del comando

external_idstring

ID único de tu sistema dentro de la cuenta autenticada

status'pending' | 'dispatched' | 'cancel_requested' | 'canceled' | 'superseded' | 'consumed' | 'failed'

Estado del comando

finalboolean

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

terminal_idstring

ID de la terminal POS

amount_in_centsinteger

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

currency'GTQ' | 'USD'

Moneda del cobro

installmentsinteger nullable

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

descriptionstring nullable

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

show_post_payment_screensboolean

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

print_receiptboolean

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

tax_idstring nullable

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

terminal_availability'available' | 'unavailable'

Disponibilidad observada de la terminal para recibir comandos

checkout_idstring

ID del checkout generado

checkout_urlstring uri

URL del checkout (la terminal usa esta URL internamente)

checkout_status'unpaid' | 'paid' | 'failed' | 'payment_in_progress' | 'needs_verification' | 'no_payment_required' | 'verification_failed' | 'needs_payer_authentication'

Estado actual del checkout asociado

cancellation_requested_atstring date-time nullable

Momento en que se solicitó detener un comando ya despachado

canceled_atstring date-time nullable

Momento en que la cancelación se volvió definitiva

Changes

  • 33bad9197d59Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

    • breaking

      the / response's property type changed from object to array for status

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API