Saltar para o conteúdo principal
POST
/
api
/
v4
/
integrations
/
sales
/
aggregator
/
orders
/
{order_uid}
/
refund
{
  "reason": "Duplicate charge",
  "vendor_uid": "vendor-uid-abc"
}

{
  "data": {
    "uid": "550e8400-e29b-41d4-a716-446655440000",
    "order_code": "ORD-2026-001234",
    "account_uid": "acc-uid-12345",
    "vendor_uid": "vendor-uid-abc",
    "store_uid": "store-uid-xyz",
    "status": "CANCELED",
    "payment_status": "REFUNDED",
    "order_lines": [],
    "totals": [],
    "payment_methods": [],
    "metadata": {},
    "created_at": "2026-03-30T12:00:00.000Z",
    "updated_at": "2026-03-30T12:05:00.000Z",
    "deleted_at": null
  },
  "status": 200,
  "method": "POST",
  "pathname": "/api/v4/integrations/sales/aggregator/orders/550e8400-e29b-41d4-a716-446655440000/refund",
  "duration": 120,
  "traceId": "abc123",
  "isArray": false
}
Cancela um pedido criado anteriormente com Injetar pedido. O Fire busca o pedido por account e order_uid, atualiza o pedido para CANCELED e devolve o pedido atualizado no envelope padrão da API. Se o processador de pagamento salvo suporta reembolsos (por exemplo, Deuna), o Fire tenta o reembolso e define payment_status como REFUNDED em caso de sucesso. Para outros processadores, o Fire cancela o estado de pagamento e define payment_status como CANCELED.
​
Authorization
string
obrigatório
Token Bearer obtido em POST /login. Formato: Bearer <accessToken>.
​
x-api-key
string
obrigatório
Sua API key do Fire.
​
x-client-channel
string
obrigatório
Deve ser integration. Identifica a requisição como vinda de uma integração externa.
​
account
string
obrigatório
Identificador da conta usado para encontrar o pedido.
​
Content-Type
string
padrão:"application/json"
Use application/json para o corpo da requisição.
​
order_uid
string
obrigatório
UID do pedido que será cancelado.
​
reason
string
obrigatório
Motivo do cancelamento ou solicitação de reembolso.
​
payment_method_uid
string
Opcional. UID do método de pagamento usado para resolver credenciais de reembolso quando você precisa direcionar um método específico.
​
vendor_uid
string
obrigatório
UID do vendor usado para resolver credenciais de pagamento.
​
email
string
Email do cliente enviado ao processador de pagamento quando aplicável.
​
customer_uid
string
UID do cliente registrado. Quando presente, o Fire trata o payload de reembolso como autenticado.
​
anonymous_customer_uid
string
UID do cliente anônimo. Usado como identificador de usuário do pagamento quando customer_uid não está presente.
​
store_uid
string
UID da loja usado para resolver credenciais de pagamento específicas da loja.
​
media
string
Meio de venda usado para resolver credenciais. Valores suportados: APP, WEB.
{
  "reason": "Duplicate charge",
  "vendor_uid": "vendor-uid-abc"
}
​
data
object
Pedido atualizado. Os preços em order_lines, totals e payment_methods são devolvidos como valores externos sem escala.
​
status
number
Código HTTP no envelope da API.
​
traceId
string
Identificador de trace para suporte e diagnóstico.
{
  "data": {
    "uid": "550e8400-e29b-41d4-a716-446655440000",
    "order_code": "ORD-2026-001234",
    "account_uid": "acc-uid-12345",
    "vendor_uid": "vendor-uid-abc",
    "store_uid": "store-uid-xyz",
    "status": "CANCELED",
    "payment_status": "REFUNDED",
    "order_lines": [],
    "totals": [],
    "payment_methods": [],
    "metadata": {},
    "created_at": "2026-03-30T12:00:00.000Z",
    "updated_at": "2026-03-30T12:05:00.000Z",
    "deleted_at": null
  },
  "status": 200,
  "method": "POST",
  "pathname": "/api/v4/integrations/sales/aggregator/orders/550e8400-e29b-41d4-a716-446655440000/refund",
  "duration": 120,
  "traceId": "abc123",
  "isArray": false
}

​
Regras de processamento

  • Quando enviado, payment_method_uid ajuda a resolver credenciais, mas o Fire avalia os métodos de pagamento salvos no pedido.
  • Para reembolsos com Deuna, o pedido deve incluir metadata.order_token; se não existir, o Fire retorna 400.
  • Depois de salvar o pedido atualizado, o Fire devolve preços transformados para consumo externo.
  • O Fire notifica o cancelamento downstream depois de salvar o pedido.