Cancelar un comando de terminal | Documentación API de Recurrente

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.

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.

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.

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`.

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

currencyenumOptional

Moneda del cobro

installmentsinteger or nullOptional

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

show_post_payment_screensbooleanOptional

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

terminal_availabilityenumOptional

Disponibilidad observada de la terminal para recibir comandos

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

1	{
2	"id": "tsc_abc12345",
3	"external_id": "order-1234",
4	"status": "pending",
5	"final": false,
6	"terminal_id": "trm_abc123",
7	"amount_in_cents": 5000,
8	"currency": "GTQ",
9	"installments": 6,
10	"show_post_payment_screens": true,
11	"terminal_availability": "available",
12	"checkout_id": "ch_xyz789",
13	"checkout_url": "https://app.recurrente.com/checkout-session/ch_xyz789",
14	"checkout_status": "unpaid",
15	"cancellation_requested_at": "2024-01-15T09:30:00Z",
16	"canceled_at": "2024-01-15T09:30:00Z"
17	}

$	curl -X DELETE https://app.recurrente.com/api/terminal_session_commands/random_id \
>	-H "X-SECRET-KEY: <apiKey>"