> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Baixe o comprovante de pagamento para reembolso (POP)

Baixe programaticamente o documento de Comprovante de Pagamento (POP) das transações de reembolso concluídas.

O Comprovante de Pagamento (POP) é o documento oficial de confirmação de uma transação de reembolso concluída. Além de baixá-lo manualmente pelo [Business Portal](https://docs.localpayment.com/pt-br/docs/dashboard-refunds-proof-of-payment.md), você pode solicitá-lo programaticamente por meio da API.

## Pré-requisitos

Antes de começar, certifique-se de ter:

* Credenciais de API válidas com um token de acesso ativo.
* Uma ou mais transações de reembolso com status `Completed`.
* O `internalId` ou `externalId` de cada transação para a qual você deseja um POP.

***

## Endpoint da API

Para baixar um POP de reembolso, envie uma requisição `POST` para o endpoint [Download Refund Proof of Payment](https://docs.localpayment.com/pt-br/reference/download-refund-proof-of-payment.md).

### Endpoint

```http theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
POST https://api.stage.localpayment.com/api/v1/refunds/proof-of-payment
```

### Autenticação

Inclua seu token de acesso nos cabeçalhos da solicitação:

```http theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
Authorization: Bearer <your_access_token>
```

### Corpo da requisição

O corpo é um array JSON de identificadores de transação. Você pode misturar valores de `internalId` e `externalId` na mesma requisição.

| Campo | Tipo | Descrição | Obrigatório |
| - | - | - | - |
| (array item) | string | `internalId` ou `externalId` de uma transação de reembolso com status `Completed` | ✅ |

### Exemplo de solicitação

```bash curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
curl --request POST \
     --url https://api.stage.localpayment.com/api/v1/refunds/proof-of-payment \
     --header 'Authorization: Bearer <your_access_token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '[
       "936c7d58-9cb2-41a1-9c20-af27bf94b6c1"
     ]'
```

***

## Tratamento de Respostas

### Resposta bem-sucedida

Em caso de sucesso, o corpo da resposta é o próprio arquivo ZIP, codificado em base64 como texto simples. Ele não é encapsulado em um campo JSON: decodifique o corpo da resposta diretamente para obter o arquivo ZIP, que contém um PDF de Comprovante de Pagamento para cada transação solicitada.

### Respostas de erro

**401 Não autorizado.** O token de acesso está ausente, é inválido ou expirou.

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "code": "token_not_valid",
  "detail": "Given token not valid for any token type",
  "messages": [
    {
      "message": "Token is invalid or expired",
      "token_class": "AccessToken",
      "token_type": "access"
    }
  ]
}
```

**403 Forbidden.** Uma ou mais das transações solicitadas não estão com status `Completed`.

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "error": "INVALID_STATUS",
  "message": "Proof of Payment is only available for Completed transactions",
  "invalid_transactions": [
    {
      "transaction_id": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
      "current_status": "Cancelled"
    }
  ]
}
```

**404 Not Found.** Nenhum dos identificadores solicitados possui informações de Comprovante de Pagamento disponíveis.

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "Status": 404,
  "Code": null,
  "Message": "There is no payments information to generate the file",
  "TraceId": "6a907fb4000000001f723f645b1fdee3"
}
```

***

## Melhores práticas de implementação

* Valide que uma transação está com status `Completed` antes de solicitar o POP dela.
* Agrupe vários IDs de transação em uma única requisição, em vez de chamar o endpoint uma vez por transação.
* Armazene os tokens de acesso em local seguro e alterne-os regularmente.

***

## Recursos e próximos passos

Maximize o sucesso da sua integração com estes recursos essenciais.

> [card] [Integração de Webhook](https://docs.localpayment.com/pt-br/docs/webhooks.md)
>
> Configure notificações em tempo real para atualizações do status das transações.

> [card] [Relatórios no Business Portal](https://docs.localpayment.com/pt-br/docs/balance-report.md)
>
> Acesse análises detalhadas, ferramentas de geração de relatórios e recursos de conciliação.

> [card] [Monitoramento de transações](https://docs.localpayment.com/pt-br/reference/transaction-status-error-codes)
>
> Aprenda a consultar o status das transações e a implementar um rastreamento abrangente.

> [card] [Referência da API](https://docs.localpayment.com/pt-br/reference/exchange-bulk.md)
>
> Documentação completa dos endpoints com exemplos interativos.

> [!NOTE]
>
> **Dica profissional**
>
> Sempre teste seu fluxo de trabalho em nosso ambiente de sandbox antes de implantá-lo em produção. Isso garante que o tratamento de erros, o processamento de webhooks e o rastreamento de status funcionem corretamente em todos os cenários.

***

> [!NOTE]
>
> **Precisa de ajuda?**
>
> Entre em contato com nossa [equipe de suporte](mailto:support@localpayment.com) caso encontre algum problema ou precise de ajuda com a integração.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.