Consultando status do Pedido

Este endpoint permite consultar o estado atual de um pedido, incluindo:

• Status geral do pedido

• Cobranças associadas

• Dados do pagamento

📌 Esse endpoint é consultivo e deve ser usado para:

• Reconciliação

• Exibição de status ao cliente

• Auditoria

• Recuperação de estado em caso de falha

⚠️ Não substitui o uso de webhooks para confirmação de pagamento.

---

Endpoint

GET /v2/orders/{uuid} https://api.barte.com/v2/orders/{uuid}

Headers

X-Token-Api: YOUR_API_KEY
Accept: */*

---

Path Param

uuid (obrigatório)

Identificador único do pedido.

📌 Deve ser o uuid retornado no momento da criação do pedido.

---

Exemplo de resposta

{
  "uuid": "e82c66cc-cdf6-4253-87b2-ed339d3b9669",
  "status": "PAID",
  "title": "Teste",
  "description": "",
  "value": 100,
  "installments": 5,
  "startDate": "2025-10-14",
  "payment": "CREDIT_CARD_EARLY_SELLER",
  "customer": {
    "uuid": "",
    "document": "001052647",
    "type": "SSN",
    "documentCountry": "US",
    "name": "Joshua Henry",
    "email": "[email protected]",
    "phone": "9409822523",
    "alternativeEmail": ""
  },
  "idempotencyKey": "b6cf42ba-3b64-4587-ba91-eec18465d091",
  "charges": [
    {
      "uuid": "f337e5a4-62a3-41af-8449-c9898f1de66b",
      "title": "Teste",
      "expirationDate": "2025-10-14",
      "paidDate": "2025-10-14",
      "value": 100,
      "paymentMethod": "CREDIT_CARD_EARLY_SELLER",
      "status": "PAID",
      "authorizationCode": "488713",
      "authorizationNsu": "154054",
      "retryable": false,
      "fee": 0.49
    }
  ]
}

---

Webhooks x Consulta

Uso	Recomendação
Confirmar pagamento	✅ Webhook
Exibir status ao cliente	✅ GET Order
Reconciliação	✅ GET Order
Auditoria	✅ GET Order
Ativar serviço	❌ GET Order

📌 Webhook é a fonte oficial de verdade para eventos financeiros.

---

Fluxo recomendado

Criar pedido
      ↓
Aguardar webhook
      ↓
Confirmar pagamento no webhook
      ↓
Persistir status final
      ↓
Usar GET /orders/{uuid} apenas para consulta

---

Boas práticas

• Sempre salve:

  • uuid do pedido

  • value

  • status

  • charges[].uuid

• Use esse endpoint para:

  • Recuperação de estado

  • Debug

  • Painéis administrativos

• Confirme pagamento somente via webhook

• Trate divergências entre webhook e GET como exceção crítica

---

O que não fazer

• Confirmar pagamento apenas com GET

• Ignorar o status das cobranças

• Confiar apenas no status do pedido sem validar charge

• Alterar estado interno baseado apenas em polling

• Expor a API Key no frontend