Consultando um Estorno Parcial

Este endpoint permite consultar o status e o histórico dos estornos parciais de uma cobrança (charge) já processada.

⚠️ Este endpoint é somente para consulta. Ele não cria, não altera e não cancela estornos.

---

Endpoint

GET /v2/charges/partial-refund/{uuid} https://api.barte.com/v2/charges/partial-refund/{uuid}

---

Headers

X-Token-Api: YOUR_API_KEY
Content-Type: application/json
Accept: */*

---

Path Param

uuid (obrigatório)

Identificador único da cobrança (charge.uuid).

📌 Esse uuid é obtido:

• Na criação do pedido

• Na consulta do pedido (GET /v2/orders/{uuid})

---

Body

Essa requisição não possui body.

---

Exemplo de resposta

[
  {
    "uuid": "9ec29500-7700-4e40-9a8a-66bf23795d06",
    "value": 0,
    "originalValue": 1000,
    "refunds": [
      {
        "id": "81877",
        "createdAt": "2026-01-30T15:55:10.000Z",
        "amount": 1000,
        "requestStatus": "processing"
      }
    ]
  }
]

---

Campos mais importantes da resposta

• uuid - Identificador único da cobrança estornada. Use para:

  • Auditoria

  • Suporte

  • Conciliação financeira

• value - Valor atual da cobrança após estornos parciais

• originalValue - Valor original da cobrança, antes de qualquer estorno

• refunds - Lista de solicitações de estorno parcial

  • refunds[].id - Identificador interno da solicitação de estorno

  • refunds[].createdAt - Data e hora da solicitação

  • refunds[].amount - Valor solicitado no estorno

  • refunds[].requestStatus - Status atual da solicitação

---

Status possíveis de requestStatus

Status	Descrição
processing	Estorno solicitado e em processamento
success	Estorno concluído com sucesso
failed	Estorno não concluído

📌 Enquanto o status estiver processing, o valor pode ainda não ter sido efetivamente devolvido ao comprador.

---

Boas práticas

• Sempre valide:

  • value

  • originalValue

  • refunds[].requestStatus

• Utilize este endpoint para:

  • Acompanhamento de estornos parciais

  • Conciliação financeira

  • Auditoria e suporte

• Armazene:

  • uuid da charge

  • Valor solicitado em cada estorno

  • Histórico de status das solicitações

---

O que não fazer

• Não tente criar novos estornos parciais enquanto existirem solicitações com status processing

• Não utilize este endpoint para criar ou cancelar estornos

• Não assuma que o estorno foi concluído sem validar o requestStatus