> ## 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.

Faça o download de um comprovante de pagamento (POP) para uma ou mais transações de pagamento concluídas.

Envie um array de valores `internalId` ou `externalId` de transações de Payout com status `Completed`. A resposta é um arquivo ZIP codificado em base64 contendo um PDF de comprovante de pagamento para cada transação solicitada.

> [!NOTE]
>
> É permitido misturar valores `internalId` e `externalId` no mesmo array da requisição.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/v1/payouts/proof-of-payment
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/v1/payouts/proof-of-payment:
    post:
      summary: Baixar comprovante de pagamento do Payout
      operationId: download-payout-proof-of-payment
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: >-
                Lista de identificadores de transação para os quais gerar
                comprovantes de pagamento. Aceita valores de `internalId` ou
                `externalId`, misturados na mesma solicitação. Todas as
                transações devem estar com o status `Completed`.
              items:
                type: string
              example:
                - 550e8400-e29b-41d4-a716-446655440000
                - f47ac10b-58cc-4372-a567-0e02b2c3d479
              x-examples:
                Example 1:
                  - 550e8400-e29b-41d4-a716-446655440000
                  - f47ac10b-58cc-4372-a567-0e02b2c3d479
            examples:
              Example 1 - Two internalId/externalId values:
                value:
                  - 550e8400-e29b-41d4-a716-446655440000
                  - f47ac10b-58cc-4372-a567-0e02b2c3d479
        required: true
      responses:
        '200':
          description: >-
            OK. O corpo da resposta é o próprio arquivo ZIP, codificado em
            base64 como texto simples (não encapsulado em um campo JSON),
            contendo um comprovante de pagamento em PDF por transação
            solicitada. Confirmado com uma captura real: os bytes decodificados
            começam com a assinatura do arquivo ZIP (`PK\x03\x04`).
          content:
            application/json:
              schema:
                type: string
                format: byte
                description: >-
                  Arquivo ZIP codificado em Base64 contendo os comprovantes de
                  pagamento em PDF solicitados. Decodifique esta string
                  diretamente para obter o arquivo ZIP; não há nenhum objeto
                  JSON envolvendo-o.
              examples:
                Example 1 - Base64-encoded ZIP (truncated):
                  value: UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==
        '401':
          description: >-
            Não autorizado. O token de acesso está ausente, é inválido ou
            expirou.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                token_not_valid - Token invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
        '403':
          description: >-
            Proibido. O comprovante de pagamento só está disponível para
            transações em `Completed` status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Código de erro.
                  message:
                    type: string
                    description: Mensagem de erro legível para humanos.
                  invalid_transactions:
                    type: array
                    description: >-
                      Transações que não estão em um status válido para o
                      Comprovante de Pagamento.
                    items:
                      type: object
                      properties:
                        transaction_id:
                          type: string
                          description: internalId ou externalId da transação inválida.
                        current_status:
                          type: string
                          description: Status atual da transação.
                x-examples:
                  Example 1:
                    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
              examples:
                INVALID_STATUS - Transaction not Completed:
                  value:
                    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':
          description: >-
            Não encontrado. Nenhum dos identificadores de transação solicitados
            possui informações de comprovante de pagamento disponíveis.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: integer
                    description: Código de status HTTP.
                  Code:
                    type: string
                    nullable: true
                    description: Código de erro interno, se houver.
                  Message:
                    type: string
                    description: Mensagem de erro legível para humanos.
                  TraceId:
                    type: string
                    description: Identificador de rastreamento para fins de suporte.
                x-examples:
                  Example 1:
                    Status: 404
                    Code: null
                    Message: There is no payments information to generate the file
                    TraceId: 6a907fb4000000001f723f645b1fdee3
              examples:
                404 - No payment information:
                  value:
                    Status: 404
                    Code: null
                    Message: There is no payments information to generate the file
                    TraceId: 6a907fb4000000001f723f645b1fdee3
      security:
        - token: []
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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