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

# Consultar cobrança PIX

> Consulta o status de uma cobrança PIX específica usando o ID da fatura de pagamento. Retorna sucesso=true para PIXs pagados e sucesso=false com status 410 para PIXs pendentes.



## OpenAPI

````yaml GET /api/pix/{idFaturaPag}
openapi: 3.1.0
info:
  title: Mycredit API
  description: API para integração com serviços PIX e gestão de contas Mycredit
  version: 1.0.0
  contact:
    name: Suporte Mycredit
    url: https://mycredit.com.br/contato
servers:
  - url: https://sandboxapi.mycredit.com.br
    description: Ambiente de sandbox
  - url: https://api.mycredit.com.br
    description: Ambiente de produção
security:
  - bearerAuth: []
paths:
  /api/pix/{idFaturaPag}:
    get:
      summary: Consultar status do PIX
      description: >-
        Consulta o status de uma cobrança PIX específica usando o ID da fatura
        de pagamento. Retorna sucesso=true para PIXs pagados e sucesso=false com
        status 410 para PIXs pendentes.
      operationId: consultarStatusPix
      parameters:
        - name: idFaturaPag
          in: path
          description: >-
            Identificador da fatura de pagamento (UUID) gerado por sua aplicação
            ao criar a cobrança PIX.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: PIX pago com sucesso - status consultado com êxito
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsultarStatusPixResponse'
        '400':
          description: Erro de validação - idFaturaPag em formato inválido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Não autorizado - token inválido ou expirado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: PIX não encontrado - idFaturaPag inválido ou inexistente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '410':
          description: PIX pendente - aguardando pagamento do cliente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ConsultarStatusPixResponse:
      type: object
      properties:
        sucesso:
          type: boolean
          description: >-
            Indica se a operação foi finalizada com sucesso. Enquanto o
            pagamento não for realizado, o sucesso será false. **O sucesso será
            true apenas quando o pagamento for realizado.**
          example: true
        data:
          type: object
          description: >-
            Dados do status do PIX consultado. Quando sucesso=true, contém
            detalhes da transação autorizada.
          properties:
            retTexto:
              type: string
              description: Mensagem de retorno da operação
              example: Autorizado com sucesso
            response:
              type: object
              description: Detalhes completos da transação autorizada
              properties:
                id:
                  type: string
                  description: Identificador único da transação PIX
                  example: d52ea68d-4c76-4e80-52c2-08dddfd74ba1
                referencia:
                  type: string
                  description: Referência da transação (idFaturaPag)
                  example: 9b041599-eacc-4a0f-9a16-e0191c9a66aa
                tpComando:
                  type: integer
                  description: Tipo de comando da transação
                  example: 0
                dRetorno:
                  type: string
                  format: date-time
                  description: Data e hora do retorno da operação
                  example: '2025-08-20T11:49:47.8151264Z'
                msgOperador:
                  type: string
                  description: Mensagem do operador da transação
                  example: OPERACAO REALIZADA COM SUCESSO
                viaCliente:
                  type: string
                  description: >-
                    Comprovante para impressão do cliente com detalhes da
                    transação
                  example: |
                    <cond> MYCREDIT 
                     VIA IMPRESSAO CLIENTE 
                     TRANSACAO AUTORIZADA 
                    CONTA: d52ea68d-4c****74ba
                    TRANSACAO: 9b041599-ea****a66a
                    VALOR: R$ 1,00
                    DATA: 20/08/2025
                    HORA: 08:48:17
                    ---
                     AUTORIZADO POR QRCODE 
                    ---
                    Saldo disponível: 
                    R$
                    mycredit.com.br 
                    <guilhotina>
                viaEstabelecimento:
                  type: string
                  description: >-
                    Comprovante para impressão do estabelecimento com detalhes
                    da transação
                  example: |
                    <cond> MYCREDIT 
                     VIA IMPRESSÃO ESTABELECIMENTO 
                     TRANSACAO AUTORIZADA 
                    CONTA: d52ea68d-4c****74ba
                    TRANSACAO: 9b041599-ea****a66a
                    VALOR: R$ 1,00
                    DATA: 20/08/2025
                    HORA: 08:48:17
                    ---
                     AUTORIZADO POR QRCODE 
                    ---
                    Saldo disponível: 
                    R$
                    mycredit.com.br 
                    <guilhotina>
                tpConfirmacao:
                  type: integer
                  description: Tipo de confirmação da transação
                  example: 0
                numCartao:
                  type: string
                  description: Número do cartão (vazio para PIX)
                  example: ''
                vLanc:
                  type: number
                  description: Valor da transação em reais
                  example: 1
                dTransacao:
                  type: string
                  format: date-time
                  description: Data e hora da transação
                  example: '2025-08-20T11:49:47.8151324Z'
                arqRetorno:
                  type: string
                  description: Arquivo de retorno (vazio para PIX)
                  example: ''
                dInsert:
                  type: string
                  format: date-time
                  description: Data e hora de inserção da transação
                  example: '2025-08-20T11:48:17.763'
                dUpdate:
                  type: string
                  format: date-time
                  description: Data e hora da última atualização da transação
                  example: '2025-08-20T11:49:43.227'
    ErrorResponse:
      type: object
      properties:
        sucesso:
          type: boolean
          description: >-
            Indica se a operação foi executada ou concluída com sucesso. Sempre
            false para respostas de erro
          example: false
        errors:
          type: string
          description: Descrição detalhada do erro ocorrido
          example: Mensagem de erro
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````