> For the complete documentation index, see [llms.txt](https://docs.barte.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.barte.com/guias/passo-a-passo-do-vendedor/3o-pos-pagamento/consultando-um-estorno-parcial.md).

# 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

```json
[
  {
    "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.

***

### <i class="fa-lightbulb">:lightbulb:</i> Boas práticas

* Sempre valide:
  * `value`
  * `originalValue`
  * `refunds[].requestStatus`
* &#x20;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

***

### <i class="fa-hexagon-xmark">:hexagon-xmark:</i> 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`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.barte.com/guias/passo-a-passo-do-vendedor/3o-pos-pagamento/consultando-um-estorno-parcial.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
