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

# Obter uma cobrança do Pix Automático

> Recupera uma única cobrança pelo id. Restrita ao pagador autenticado — uma cobrança de outro pagador é reportada como não encontrada. A resposta traz o array de tentativas sanitizado; o código de resultado do débito nunca é exposto.



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml GET /v1/recurrences/payer/charges/{id}
openapi: 3.0.3
info:
  title: Plugin BR Pix Indireto - API Completa
  description: |
    API completa para o sistema brasileiro de pagamentos instantâneos Pix,
    incluindo operações de dicionário de chaves Pix, geração/decodificação de
    QR Code, transações e limites de transações.
  version: 1.7.6
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/recurrences/payer/charges/{id}:
    get:
      tags:
        - Pix Automático API
      summary: Obter uma cobrança do Pix Automático
      description: >-
        Recupera uma única cobrança pelo id. Restrita ao pagador autenticado —
        uma cobrança de outro pagador é reportada como não encontrada. A
        resposta traz o array de tentativas sanitizado; o código de resultado do
        débito nunca é exposto.
      parameters:
        - $ref: '#/components/parameters/XAccountId'
        - name: id
          in: path
          description: ID da cobrança (formato UUID)
          required: true
          schema:
            type: string
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      security:
        - bearerAuth: []
components:
  parameters:
    XAccountId:
      name: X-Account-Id
      in: header
      description: Identificador único da Conta do Ledger Midaz (formato UUID).
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
  schemas:
    ChargeOutput:
      properties:
        accountId:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        amount:
          example: '29.90'
          type: string
        attemptCount:
          type: integer
          example: 1
        attempts:
          items:
            $ref: '#/components/schemas/ChargeAttemptOutput'
          type: array
        authorizationId:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        authorizationRequestId:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        cancelledAt:
          format: date-time
          type: string
        createdAt:
          format: date-time
          type: string
        currentDayIndex:
          type: integer
          example: 0
        currentScheduleId:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        dueDate:
          example: '2026-04-25'
          format: date
          type: string
        executedAt:
          format: date-time
          type: string
        externalChargeId:
          example: 90d0b9e1551447f695985409bf9b7fb5
          type: string
        failedAt:
          format: date-time
          type: string
        failureCode:
          description: >-
            FailureCode é o código genérico que preserva a privacidade reportado
            ao recebedor para o resultado atual da cobrança (por exemplo,
            CHARGE_REJECTED, OVER_LIMIT, ACCEPTED, DEBIT_FAILED). É o ÚNICO
            código exposto na API de leitura e no payload de saída — o motivo
            financeiro nunca é transmitido aqui.
          example: CHARGE_REJECTED
          type: string
        id:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        journey:
          enum:
            - J1
            - J2
            - J3
            - J4
          example: J4
          type: string
        maxAttempts:
          example: 4
          type: integer
        recurrenceId:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        status:
          enum:
            - RECEIVED
            - SCHEDULED
            - EXECUTED
            - FAILED
            - CANCELLED
          example: SCHEDULED
          type: string
        updatedAt:
          format: date-time
          type: string
      type: object
    ErrorFormat:
      type: object
      description: A mensagem de erro da resposta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
    ChargeAttemptOutput:
      properties:
        attemptedAt:
          description: >-
            AttemptedAt é o instante de observação do resultado da tentativa — o
            instante canônico da tentativa, ISO 8601 UTC. Omitido enquanto a
            tentativa ainda está aberta (nenhum resultado terminal observado
            ainda). Diferente de ScheduledFor, o instante de disparo planejado.
          format: date-time
          type: string
        dayIndex:
          type: integer
          example: 0
        endToEndId:
          description: >-
            EndToEndID é o id end-to-end do cashout gerado para esta tentativa,
            usado para reconciliar a liquidação. Omitido para uma tentativa
            legada que não tenha um.
          example: E30306294202606241200abcdef00001
          type: string
        failureCode:
          description: >-
            FailureCode é o código que preserva a privacidade já reportado ao
            recebedor para esta tentativa (por exemplo, DEBIT_FAILED). Vazio
            quando nada foi reportado ainda. O motivo financeiro nunca é
            transmitido aqui.
          example: DEBIT_FAILED
          type: string
        failureMessage:
          description: >-
            FailureMessage é uma descrição aproximada e segura para o canal do
            resultado. Nunca revela o código de resultado interno.
          example: The debit attempt could not be completed.
          type: string
        outcome:
          enum:
            - EXECUTED
            - FAILED
            - CANCELLED
          example: EXECUTED
          type: string
        scheduleId:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        scheduledFor:
          example: '2026-04-24T03:00:00Z'
          format: date-time
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````