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

# Consultar Pagamento

> Recupera o status atual e detalhes de um pagamento.

**Autenticação:** Requer uma API Key válida no header `X-API-Key`.

**Nota:** Você só pode recuperar pagamentos criados com suas API Keys.



## OpenAPI

````yaml GET /v1/payments/{id}
openapi: 3.0.0
info:
  title: Paybridge Public API
  description: >-
    API para integração de pagamentos PIX.


    ## Autenticação


    Todas as requisições devem incluir um header `X-API-Key` com uma API Key
    válida.


    ### Tipos de API Key

    - **Chaves de Teste** (`pk_test_*`): Usadas para pagamentos em
    sandbox/teste. Sem transações reais.

    - **Chaves de Produção** (`pk_live_*`): Usadas para pagamentos em produção.
    Transações reais.


    ### Exemplo

    ```

    X-API-Key: pk_test_abc123...

    ```


    ## Limite de Requisições


    Requisições à API são limitadas a 100 por minuto por API Key.


    ## Webhooks


    Configure webhooks no dashboard para receber atualizações de status dos
    pagamentos.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.paybridge.dev
security: []
tags:
  - name: Pagamentos
    description: Operações de pagamento PIX
paths:
  /v1/payments/{id}:
    get:
      tags:
        - Pagamentos
      summary: Obter detalhes do pagamento
      description: |-
        Recupera o status atual e detalhes de um pagamento.

        **Autenticação:** Requer uma API Key válida no header `X-API-Key`.

        **Nota:** Você só pode recuperar pagamentos criados com suas API Keys.
      operationId: PublicPaymentsController_get
      parameters:
        - name: id
          required: true
          in: path
          description: ID do pagamento (UUID)
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            type: string
      responses:
        '200':
          description: Detalhes do pagamento recuperados com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentOutput'
        '401':
          description: API Key inválida ou ausente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiUnauthorizedResponse'
        '404':
          description: Pagamento não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiNotFoundResponse'
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiInternalErrorResponse'
      security:
        - X-API-Key: []
components:
  schemas:
    GetPaymentOutput:
      type: object
      properties:
        id:
          type: string
          description: ID único do pagamento
        amount:
          type: number
          description: Valor do pagamento
        currency:
          type: string
          description: Moeda (BRL)
        description:
          type: string
          description: Descrição do pagamento
        externalId:
          type: string
          description: ID de referência externa
        status:
          type: string
          description: Status do pagamento
        provider:
          type: string
          description: Provedor de pagamento
        pixCopyPaste:
          type: string
          description: Código PIX copia e cola
        pixQrCodeBase64:
          type: string
          description: QR Code em Base64
        expiresAt:
          format: date-time
          type: string
          description: Data de expiração
        confirmedAt:
          format: date-time
          type: string
          description: Data de confirmação do pagamento
        payerName:
          type: string
          description: Nome do pagador
        payerDocument:
          type: string
          description: Documento do pagador
        payerEmail:
          type: string
          description: E-mail do pagador
        createdAt:
          format: date-time
          type: string
          description: Data de criação
        isTest:
          type: boolean
          description: Se é um pagamento de teste/sandbox
        metadata:
          type: object
          example:
            orderId: '123'
            source: mobile
          description: Metadados customizados
      required:
        - id
        - amount
        - currency
        - status
        - provider
        - createdAt
    PublicApiUnauthorizedResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Invalid or missing API Key
        timestamp:
          type: string
          example: '2026-01-21T22:00:00.000Z'
      required:
        - statusCode
        - error
        - message
        - timestamp
    PublicApiNotFoundResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: NotFound
        message:
          type: string
          example: Payment with id 550e8400-e29b-41d4-a716-446655440000 not found
        details:
          type: object
          example:
            resource: Payment
            id: 550e8400-e29b-41d4-a716-446655440000
        timestamp:
          type: string
          example: '2026-01-21T22:00:00.000Z'
      required:
        - statusCode
        - error
        - message
        - timestamp
    PublicApiInternalErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: InternalError
        message:
          type: string
          example: An unexpected error occurred
        timestamp:
          type: string
          example: '2026-01-21T22:00:00.000Z'
        traceId:
          type: string
          example: 2771463d58840c8e116dc6dda1e1e5d0
      required:
        - statusCode
        - error
        - message
        - timestamp
  securitySchemes:
    X-API-Key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key para autenticação (pk_live_* ou pk_test_*)

````