Cancelar Pedido

POST /v1/orders/cancel

Cancela um pedido que ainda está no status new.

Sem reembolso automático

Uma vez que um pedido é cancelado, qualquer TRX recebido posteriormente para esse pedido não é reembolsado automaticamente. Cancele pedidos apenas quando tiver certeza de que o usuário ainda não enviou o depósito.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
order_id	string	sim	ULID retornado por POST /v1/orders.

Exemplos

Bash

curl -X POST https://api.tronzap.com/v1/orders/cancel \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "order_id": "01HZX5N6Q9TY3K2P0VWB7HRD4M"
  }'

Node.js

const response = await fetch('https://api.tronzap.com/v1/orders/cancel', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
  },
  body: JSON.stringify({ order_id: '01HZX5N6Q9TY3K2P0VWB7HRD4M' }),
})
const { result } = await response.json()
console.log(result.status) // "cancelled"

PHP

$response = file_get_contents('https://api.tronzap.com/v1/orders/cancel', false, stream_context_create([
  'http' => [
    'method' => 'POST',
    'header' => "Content-Type: application/json\r\nAccept: application/json",
    'content' => json_encode(['order_id' => '01HZX5N6Q9TY3K2P0VWB7HRD4M']),
  ],
]));
$data = json_decode($response, true)['result'];

Python

import requests

resp = requests.post('https://api.tronzap.com/v1/orders/cancel', json={
    'order_id': '01HZX5N6Q9TY3K2P0VWB7HRD4M',
})
print(resp.json()['result']['status'])  # "cancelled"

Resposta

{
  "code": 0,
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "result": {
    "order_id": "01HZX5N6Q9TY3K2P0VWB7HRD4M",
    "status": "cancelled",
    "deposit_address": "TLa2f6VPqDgRE67v1736s7bJ8Ray5wYjU7",
    "amount": 2.69,
    "currency": "TRX",
    "expires_at": "2026-05-18T16:07:05+00:00",
    "ttl": 0
  }
}

Casos de erro

Situação	Resultado
Pedido não está no status new	Erro — não é possível cancelar um pedido que já foi pago, está em processamento ou em estado terminal.
order_id não encontrado	Erro — veja Códigos de Erro.