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

# Consultar pagamento por QR Pix

> Consulta o estado público e os dados de conciliação de um pagamento por QR Pix.

## Caso de uso

Use esta operação para acompanhar um pagamento iniciado por [Solicitar pagamento por QR Pix](https://docs.turbofypay.com/pages/reference/payouts/solicitar-pagamento-qr-pix.md).

## Autenticação

* `x-client-id`
* `x-client-secret`
* Escopo `payout:read`

## Request

* `paymentId` (path): UUID retornado ao solicitar o pagamento.

## Resposta

Em `200`, a API retorna `paymentId`, `status`, `amountCents`, `feeCents`, `totalDebitedCents`, `currency`, `endToEndId` e `failureCode`. `endToEndId` e `failureCode` podem ser `null`. `currency` é sempre `BRL`. Quando `status` é `FAILED`, `failureCode` é `PIX_QR_PAYMENT_FAILED`.

Os estados públicos são `QUEUED`, `PROCESSING`, `RECONCILIATION_REQUIRED`, `COMPLETED` e `FAILED`. A consulta é restrita ao merchant autenticado. Um `paymentId` inexistente ou pertencente a outro merchant retorna `404`.

## Próximos passos

1. Para iniciar um pagamento, siga o fluxo em [Pagar com QR Pix](https://docs.turbofypay.com/pages/reference/payouts/pagar-com-qr-pix.md).
2. Use o `endToEndId` retornado quando disponível para conciliação.


## OpenAPI

````yaml GET /v1/payouts/pix-qr/{paymentId}
openapi: 3.0.3
info:
  title: Turbofy Public API
  version: 2.0.0
  description: >-
    Especificacao publica da API TurbofyPay para Cobranca PIX, Saldo, Saques,
    Webhooks e Payouts.
  contact:
    name: Turbofy Team
    email: suporte@turbofy.com
    url: https://turbofy.com
  license:
    name: Proprietary
    url: https://turbofy.com/terms
servers:
  - url: http://localhost:3030
    description: Development Server
  - url: https://api.turbofypay.com
    description: Production Server
security: []
tags:
  - name: Cobranca PIX
    description: Operacoes de cobranca PIX para integradores.
  - name: Saques
    description: Operacoes de saque para sellers.
  - name: Webhooks
    description: Cadastro e consulta de webhooks.
  - name: Payouts
    description: Gestao de lotes de payout.
  - name: Saldo
    description: Consulta do proprio saldo com credenciais de integracao.
externalDocs:
  description: Documentação completa
  url: https://docs.turbofy.com
paths:
  /v1/payouts/pix-qr/{paymentId}:
    get:
      tags:
        - Payouts
      summary: Consultar pagamento Pix por QR Code
      description: >-
        Consulta o estado público de um pagamento por QR Pix. Requer o escopo
        payout:read. Um pagamento de outro merchant retorna 404.
      operationId: getPixQrPayment
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: paymentId
          required: true
        - $ref: '#/components/parameters/XClientId'
        - $ref: '#/components/parameters/XClientSecret'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  paymentId:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - QUEUED
                      - PROCESSING
                      - RECONCILIATION_REQUIRED
                      - COMPLETED
                      - FAILED
                  amountCents:
                    type: integer
                    minimum: 0
                  feeCents:
                    type: integer
                    minimum: 0
                  totalDebitedCents:
                    type: integer
                    minimum: 0
                  currency:
                    type: string
                    enum:
                      - BRL
                  endToEndId:
                    type: string
                    nullable: true
                  failureCode:
                    type: string
                    nullable: true
                required:
                  - paymentId
                  - status
                  - amountCents
                  - feeCents
                  - totalDebitedCents
                  - currency
                  - endToEndId
                  - failureCode
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: object
                    additionalProperties: false
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
      security:
        - clientCredentials: []
          clientSecret: []
components:
  parameters:
    XClientId:
      name: x-client-id
      in: header
      required: true
      schema:
        type: string
      description: Identificador do integrador.
    XClientSecret:
      name: x-client-secret
      in: header
      required: true
      schema:
        type: string
      description: Segredo de autenticacao do integrador.
  securitySchemes:
    clientCredentials:
      type: apiKey
      in: header
      name: x-client-id
      description: Client ID fornecido pela TurbofyPay.
    clientSecret:
      type: apiKey
      in: header
      name: x-client-secret
      description: Client Secret fornecido pela TurbofyPay.

````

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