> ## 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.

# Get a Pix Automático Charge

> Retrieve a single charge by id. Scoped to the authenticated payer. The response carries the sanitized attempts array; the internal debit result code is never exposed.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/charges/{id}
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  license:
    name: Lerian Studio General License
  title: Pix BTG API
  version: 1.14.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/recurrences/payer/charges/{id}:
    get:
      tags:
        - Pix Automático
      summary: Get a Pix Automático Charge
      description: >-
        Retrieve a single charge by id. Scoped to the authenticated payer. The
        response carries the sanitized attempts array; the internal debit result
        code is never exposed.
      operationId: recurring-get-charge
      parameters:
        - description: Charge ID (UUID format)
          in: path
          name: id
          required: true
          schema:
            description: Charge ID (UUID format)
            format: uuid
            type: string
        - description: Account ID (UUID format)
          in: header
          name: X-Account-Id
          required: true
          schema:
            description: Account ID (UUID format)
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    ChargeOutput:
      additionalProperties: false
      properties:
        accountId:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        amount:
          examples:
            - '29.90'
          type: string
        attemptCount:
          examples:
            - 1
          format: int64
          type: integer
        attempts:
          items:
            $ref: '#/components/schemas/ChargeAttemptOutput'
          type: array
        authorizationId:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        authorizationRequestId:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        cancelledAt:
          format: date-time
          type: string
        createdAt:
          format: date-time
          type: string
        currentDayIndex:
          examples:
            - 0
          format: int64
          type: integer
        currentScheduleId:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        dueDate:
          examples:
            - '2026-04-25'
          format: date
          type: string
        executedAt:
          format: date-time
          type: string
        externalChargeId:
          examples:
            - 90d0b9e1551447f695985409bf9b7fb5
          type: string
        failedAt:
          format: date-time
          type: string
        failureCode:
          examples:
            - CHARGE_REJECTED
          type: string
        id:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        journey:
          enum:
            - J1
            - J2
            - J3
            - J4
          examples:
            - J4
          type: string
        maxAttempts:
          examples:
            - 4
          format: int64
          type: integer
        recurrenceId:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        status:
          enum:
            - RECEIVED
            - SCHEDULED
            - EXECUTED
            - FAILED
            - CANCELLED
          examples:
            - SCHEDULED
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - accountId
        - authorizationRequestId
        - externalChargeId
        - amount
        - dueDate
        - attemptCount
        - maxAttempts
        - status
        - journey
        - attempts
        - createdAt
        - updatedAt
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        code:
          type: string
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    ChargeAttemptOutput:
      additionalProperties: false
      properties:
        attemptedAt:
          format: date-time
          type: string
        dayIndex:
          examples:
            - 0
          format: int64
          type: integer
        endToEndId:
          examples:
            - E30306294202606241200abcdef00001
          type: string
        failureCode:
          examples:
            - DEBIT_FAILED
          type: string
        failureMessage:
          examples:
            - The debit attempt could not be completed.
          type: string
        outcome:
          enum:
            - EXECUTED
            - FAILED
            - CANCELLED
          examples:
            - EXECUTED
          type: string
        scheduleId:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        scheduledFor:
          examples:
            - '2026-04-24T03:00:00Z'
          format: date-time
          type: string
      required:
        - scheduleId
        - dayIndex
        - scheduledFor
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

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