Sign in
terminalSessionCommands

Consultar un comando de terminal

Retorna el estado actual del comando. final: true indica que ya no puede cambiar: el resultado será canceled, superseded, consumed o failed.

Usa esta consulta para reconciliar timeouts y evitar crear un segundo cobro mientras el primer comando siga en pending, dispatched o cancel_requested.

get/terminal_session_commands/{random_id}

Path parameters

random_idstring required

Headers

X-SECRET-KEYstring required

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.

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.

Response

Estado actual del comando

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

currency'GTQ' | 'USD'

Moneda del cobro

installmentsinteger nullable

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

show_post_payment_screensboolean

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

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

No recorded changes to this endpoint across all 1 revision of this API.