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

# Buscar reembolso por ID

> Retorna um reembolso específico pelo seu ID, com o estado atual e as datas do ciclo.

`GET /refunds/:id`

Faz parte do recurso [Reembolsos](/pt-BR/refunds) — o objeto, os status e o ciclo estão lá.


## OpenAPI

````yaml openapi/psp.json GET /refunds/{id}
openapi: 3.0.3
info:
  title: Z2Pay PSP API
  version: 1.0.0
  description: API pública do PSP — autenticação via API Key (Credential)
servers:
  - url: https://api.sandbox.z2pay.com/v1
    description: Sandbox
  - url: https://api.z2pay.com/v1
    description: Produção
security: []
tags:
  - name: Cards
    description: Cartões salvos de um cliente
  - name: Chargebacks
    description: Gerenciamento de chargebacks
  - name: Customers
    description: Gerenciamento de clientes (compradores)
  - name: Fees
    description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
  - name: Recipients
    description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
  - name: Refunds
    description: Gerenciamento de reembolsos e estornos
  - name: Splits
    description: Regras de divisão do valor de uma venda entre recebedores
  - name: Transactions
    description: Gerenciamento de transações e payments
  - name: Wallets
    description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
  - name: Webhooks
    description: Configuração, gerenciamento e histórico de entregas de webhooks
  - name: Withdrawals
    description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
  /refunds/{id}:
    get:
      tags:
        - Refunds
      summary: Buscar refund por ID
      description: Retorna os dados de um refund específico
      operationId: RefundController_getById
      parameters:
        - name: id
          in: path
          required: true
          description: ID do refund
          schema:
            type: string
      responses:
        '200':
          description: Dados do refund
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Identificador único do registro.
                  transactionId:
                    type: string
                    description: ID da transação relacionada ao registro.
                  paymentId:
                    type: string
                    description: ID do pagamento relacionado ao registro.
                  amount:
                    type: integer
                    description: Valor em centavos.
                  currency:
                    type: string
                    description: 'Moeda no padrão ISO 4217 (ex.: BRL).'
                  status:
                    type: string
                    description: >-
                      Situação do reembolso. Valores: `pending`, `approved`,
                      `processing`, `refunded`, `refused`, `failed`,
                      `awaiting_bank_details`, `bank_details_received`,
                      `invalid_bank_details`, `ted_processing`.
                  reason:
                    type: string
                    description: Motivo informado para a operação.
                  requestedByType:
                    type: string
                    description: >-
                      Origem da solicitação: `api`, `admin`, `customer` ou
                      `gateway`.
                  paymentMethod:
                    type: string
                    nullable: true
                    description: 'Forma de pagamento (ex.: credit_card, pix, boleto).'
                  customerId:
                    type: string
                    nullable: true
                    description: >-
                      Comprador da venda estornada (`cust_`), copiado da
                      transação quando o estorno é criado. Nulo quando a
                      transação não tem cliente.
                  customerName:
                    type: string
                    nullable: true
                    description: Nome do comprador quando o estorno foi criado.
                  customerEmail:
                    type: string
                    nullable: true
                    description: E-mail do comprador quando o estorno foi criado.
                  customerDocument:
                    type: string
                    nullable: true
                    description: >-
                      Documento do comprador (CPF ou CNPJ) quando o estorno foi
                      criado.
                  customerDocumentType:
                    type: string
                    nullable: true
                    description: 'Tipo do documento do comprador: `cpf` ou `cnpj`.'
                  additionalInfo:
                    type: object
                    nullable: true
                    properties:
                      checkoutLinkId:
                        type: string
                        description: >-
                          Id do link de checkout (`chk_`) da venda de origem — a
                          mesma chave do `additionalInfo` da transação.
                    description: >-
                      Vínculo com a venda de origem, copiado da transação quando
                      o estorno é criado. Nulo quando a venda foi criada direto
                      pela API, sem link de checkout.
                  failureReason:
                    type: string
                    nullable: true
                    description: Motivo da falha do processamento.
                  reviewedAt:
                    type: string
                    format: date-time
                    nullable: true
                    description: Data e hora em que a solicitação foi revisada (ISO 8601).
                  refundedAt:
                    type: string
                    format: date-time
                    nullable: true
                    description: Data e hora em que o estorno foi concluído (ISO 8601).
                  createdAt:
                    type: string
                    format: date-time
                    description: Data e hora de criação do registro (ISO 8601).
                  updatedAt:
                    type: string
                    format: date-time
                    description: Data e hora da última atualização do registro (ISO 8601).
              example:
                id: rfd_j3cpkaysqmix17mxhcmv8qypl
                transactionId: txn_aqbcw2lky42xfidw5pcdss8h1
                paymentId: pay_jxt9b5qv1x0h0h8ustleqjgr8
                amount: 14990
                currency: BRL
                status: pending
                reason: Cliente solicitou cancelamento da compra
                requestedByType: api
                paymentMethod: credit_card
                customerId: cust_lhsmn6ugmjotm5qvnunrr2hz1
                customerName: Maria Silva
                customerEmail: maria.silva@example.com
                customerDocument: '12345678909'
                customerDocumentType: cpf
                additionalInfo:
                  checkoutLinkId: chk_byd8p3p79re859jpkmr0j65n3
                failureReason: null
                reviewedAt: null
                refundedAt: null
                createdAt: '2025-06-29T13:45:30.000Z'
                updatedAt: '2025-06-29T13:45:30.000Z'
        '401':
          description: Chave de API ausente, malformada ou inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Identificador estável do erro. É por ele que você deve
                          ramificar, não pela mensagem.
                      message:
                        type: string
                        description: >-
                          Descrição legível. Pode mudar sem aviso e não deve ser
                          usada em condicional.
              example:
                error:
                  code: UNAUTHORIZED
                  message: Invalid API key
        '404':
          description: Refund não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Identificador estável do erro. É por ele que você deve
                          ramificar, não pela mensagem.
                      message:
                        type: string
                        description: >-
                          Descrição legível. Pode mudar sem aviso e não deve ser
                          usada em condicional.
              example:
                error:
                  code: NOT_FOUND
                  message: Refund not found
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key da Credential (gerada no Backoffice)

````