> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.recurrente.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.recurrente.com/_mcp/server.

# Cancelar un comando de terminal

DELETE https://app.recurrente.com/api/terminal_session_commands/{random_id}

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.


Reference: https://docs.recurrente.com/referencia-api/api-reference/terminal-session-commands/cancel-terminal-session-command

## Authentication

- `X-SECRET-KEY` header (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. 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`.

## Request

### Path parameters

- `random_id` (string, required)

## Response

### 200

Cancelación confirmada o ya confirmada

- `id` (string, optional) — ID público aleatorio del comando
- `external_id` (string, optional) — ID único de tu sistema dentro de la cuenta autenticada
- `status` (enum, optional) — Estado del comando
  - Allowed values: `pending`, `dispatched`, `cancel_requested`, `canceled`, `superseded`, `consumed`, `failed`
- `final` (boolean, optional) — `true` cuando el comando alcanzó un resultado definitivo y ya no puede cambiar
- `terminal_id` (string, optional) — ID de la terminal POS
- `amount_in_cents` (integer, optional) — Monto en centavos. Para un cobro con `items`, la suma de los items.
- `currency` (enum, optional) — Moneda del cobro
  - Allowed values: `GTQ`, `USD`
- `installments` (integer, optional, nullable) — Meses sin intereses solicitados, o `null` si el cobro va sin cuotas
- `description` (string, optional, nullable) — Concepto del cobro enviado al crear el comando, o `null` si no se envió uno
- `show_post_payment_screens` (boolean, optional) — Indica si el comando solicita mostrar las pantallas post-pago de NIT, correo y teléfono
- `print_receipt` (boolean, optional) — Indica si el comando solicita imprimir automáticamente el comprobante de pago
- `tax_id` (string, optional, nullable) — NIT del comprador enviado con el cobro, o `null` si no se envió uno
- `terminal_availability` (enum, optional) — Disponibilidad observada de la terminal para recibir comandos
  - Allowed values: `available`, `unavailable`
- `checkout_id` (string, optional) — ID del checkout generado
- `checkout_url` (string, optional) — URL del checkout (la terminal usa esta URL internamente)
- `checkout_status` (enum, optional) — Estado actual del checkout asociado
  - Allowed values: `unpaid`, `paid`, `failed`, `payment_in_progress`, `needs_verification`, `no_payment_required`, `verification_failed`, `needs_payer_authentication`
- `cancellation_requested_at` (datetime, optional, nullable) — Momento en que se solicitó detener un comando ya despachado
- `canceled_at` (datetime, optional, nullable) — Momento en que la cancelación se volvió definitiva

### 202

La terminal recibió una solicitud de cancelación todavía no definitiva

- `id` (string, optional) — ID público aleatorio del comando
- `external_id` (string, optional) — ID único de tu sistema dentro de la cuenta autenticada
- `status` (enum, optional) — Estado del comando
  - Allowed values: `pending`, `dispatched`, `cancel_requested`, `canceled`, `superseded`, `consumed`, `failed`
- `final` (boolean, optional) — `true` cuando el comando alcanzó un resultado definitivo y ya no puede cambiar
- `terminal_id` (string, optional) — ID de la terminal POS
- `amount_in_cents` (integer, optional) — Monto en centavos. Para un cobro con `items`, la suma de los items.
- `currency` (enum, optional) — Moneda del cobro
  - Allowed values: `GTQ`, `USD`
- `installments` (integer, optional, nullable) — Meses sin intereses solicitados, o `null` si el cobro va sin cuotas
- `description` (string, optional, nullable) — Concepto del cobro enviado al crear el comando, o `null` si no se envió uno
- `show_post_payment_screens` (boolean, optional) — Indica si el comando solicita mostrar las pantallas post-pago de NIT, correo y teléfono
- `print_receipt` (boolean, optional) — Indica si el comando solicita imprimir automáticamente el comprobante de pago
- `tax_id` (string, optional, nullable) — NIT del comprador enviado con el cobro, o `null` si no se envió uno
- `terminal_availability` (enum, optional) — Disponibilidad observada de la terminal para recibir comandos
  - Allowed values: `available`, `unavailable`
- `checkout_id` (string, optional) — ID del checkout generado
- `checkout_url` (string, optional) — URL del checkout (la terminal usa esta URL internamente)
- `checkout_status` (enum, optional) — Estado actual del checkout asociado
  - Allowed values: `unpaid`, `paid`, `failed`, `payment_in_progress`, `needs_verification`, `no_payment_required`, `verification_failed`, `needs_payer_authentication`
- `cancellation_requested_at` (datetime, optional, nullable) — Momento en que se solicitó detener un comando ya despachado
- `canceled_at` (datetime, optional, nullable) — Momento en que la cancelación se volvió definitiva

## Errors

### 404 Not Found Error

No existe un comando con ese random_id en la cuenta autenticada

- `message` (string, optional) — Mensaje de error
- `code` (string, optional) — Código estable legible por máquinas, cuando aplica
- `refund_id` (string, optional) — ID del reembolso relacionado cuando aplica
- `endpoint` (string, optional) — Acción de API rechazada, cuando aplica
- `errors` (ErrorErrors, optional) — Detalles de errores por campo

### 409 Conflict Error

El comando ya alcanzó un resultado definitivo y no se puede cancelar

- `id` (string, optional) — ID público aleatorio del comando
- `external_id` (string, optional) — ID único de tu sistema dentro de la cuenta autenticada
- `status` (enum, optional) — Estado del comando
  - Allowed values: `pending`, `dispatched`, `cancel_requested`, `canceled`, `superseded`, `consumed`, `failed`
- `final` (boolean, optional) — `true` cuando el comando alcanzó un resultado definitivo y ya no puede cambiar
- `terminal_id` (string, optional) — ID de la terminal POS
- `amount_in_cents` (integer, optional) — Monto en centavos. Para un cobro con `items`, la suma de los items.
- `currency` (enum, optional) — Moneda del cobro
  - Allowed values: `GTQ`, `USD`
- `installments` (integer, optional, nullable) — Meses sin intereses solicitados, o `null` si el cobro va sin cuotas
- `description` (string, optional, nullable) — Concepto del cobro enviado al crear el comando, o `null` si no se envió uno
- `show_post_payment_screens` (boolean, optional) — Indica si el comando solicita mostrar las pantallas post-pago de NIT, correo y teléfono
- `print_receipt` (boolean, optional) — Indica si el comando solicita imprimir automáticamente el comprobante de pago
- `tax_id` (string, optional, nullable) — NIT del comprador enviado con el cobro, o `null` si no se envió uno
- `terminal_availability` (enum, optional) — Disponibilidad observada de la terminal para recibir comandos
  - Allowed values: `available`, `unavailable`
- `checkout_id` (string, optional) — ID del checkout generado
- `checkout_url` (string, optional) — URL del checkout (la terminal usa esta URL internamente)
- `checkout_status` (enum, optional) — Estado actual del checkout asociado
  - Allowed values: `unpaid`, `paid`, `failed`, `payment_in_progress`, `needs_verification`, `no_payment_required`, `verification_failed`, `needs_payer_authentication`
- `cancellation_requested_at` (datetime, optional, nullable) — Momento en que se solicitó detener un comando ya despachado
- `canceled_at` (datetime, optional, nullable) — Momento en que la cancelación se volvió definitiva
- `message` (string, optional) — Mensaje de error
- `code` (string, optional) — Código estable legible por máquinas, cuando aplica
- `refund_id` (string, optional) — ID del reembolso relacionado cuando aplica
- `endpoint` (string, optional) — Acción de API rechazada, cuando aplica
- `errors` (TerminalSessionCommandsRandomIdDeleteResponsesContentApplicationJsonSchemaErrors, optional) — Detalles de errores por campo

## Types

### ErrorErrors

Detalles de errores por campo

### TerminalSessionCommandsRandomIdDeleteResponsesContentApplicationJsonSchemaErrors

Detalles de errores por campo

## Examples

### Example 1

**Response**

```json
{
  "id": "tsc_abc12345",
  "external_id": "order-1234",
  "status": "pending",
  "final": false,
  "terminal_id": "trm_abc123",
  "amount_in_cents": 5000,
  "currency": "GTQ",
  "installments": 6,
  "description": "Orden #1234",
  "show_post_payment_screens": true,
  "print_receipt": true,
  "tax_id": "98765432",
  "terminal_availability": "available",
  "checkout_id": "ch_xyz789",
  "checkout_url": "https://app.recurrente.com/checkout-session/ch_xyz789",
  "checkout_status": "unpaid",
  "cancellation_requested_at": "2024-01-15T09:30:00Z",
  "canceled_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://app.recurrente.com/api/terminal_session_commands/random_id"

headers = {"X-SECRET-KEY": "<apiKey>"}

response = requests.delete(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.recurrente.com/api/terminal_session_commands/random_id';
const options = {method: 'DELETE', headers: {'X-SECRET-KEY': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.recurrente.com/api/terminal_session_commands/random_id"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-SECRET-KEY", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.recurrente.com/api/terminal_session_commands/random_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-SECRET-KEY"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.delete("https://app.recurrente.com/api/terminal_session_commands/random_id")
  .header("X-SECRET-KEY", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://app.recurrente.com/api/terminal_session_commands/random_id', [
  'headers' => [
    'X-SECRET-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.recurrente.com/api/terminal_session_commands/random_id");
var request = new RestRequest(Method.DELETE);
request.AddHeader("X-SECRET-KEY", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-SECRET-KEY": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.recurrente.com/api/terminal_session_commands/random_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Response**

```json
{
  "id": "tsc_abc12345",
  "external_id": "order-1234",
  "status": "pending",
  "final": false,
  "terminal_id": "trm_abc123",
  "amount_in_cents": 5000,
  "currency": "GTQ",
  "installments": 6,
  "description": "Orden #1234",
  "show_post_payment_screens": true,
  "print_receipt": true,
  "tax_id": "98765432",
  "terminal_availability": "available",
  "checkout_id": "ch_xyz789",
  "checkout_url": "https://app.recurrente.com/checkout-session/ch_xyz789",
  "checkout_status": "unpaid",
  "cancellation_requested_at": "2024-01-15T09:30:00Z",
  "canceled_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://app.recurrente.com/api/terminal_session_commands/random_id"

headers = {"X-SECRET-KEY": "<apiKey>"}

response = requests.delete(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.recurrente.com/api/terminal_session_commands/random_id';
const options = {method: 'DELETE', headers: {'X-SECRET-KEY': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.recurrente.com/api/terminal_session_commands/random_id"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-SECRET-KEY", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.recurrente.com/api/terminal_session_commands/random_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-SECRET-KEY"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.delete("https://app.recurrente.com/api/terminal_session_commands/random_id")
  .header("X-SECRET-KEY", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://app.recurrente.com/api/terminal_session_commands/random_id', [
  'headers' => [
    'X-SECRET-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.recurrente.com/api/terminal_session_commands/random_id");
var request = new RestRequest(Method.DELETE);
request.AddHeader("X-SECRET-KEY", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-SECRET-KEY": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.recurrente.com/api/terminal_session_commands/random_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```