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

# Consultar Cobrança

> Retorna todos os detalhes de uma cobrança, incluindo `brCode`,
`imageBase64`, `end2endId`, customer e timestamps.


Retorna **todos os detalhes** de uma cobrança: status atual, QR Code, customer
vinculado e timestamps de criação/pagamento/atualização.

<Warning>
  O `id` é passado como **query string**, não como parte do caminho:
  `GET /transparents/check?id=chg_018f8e2d9a5f7b10c3d4`.
</Warning>

**Exemplo de resposta (cobrança paga):**

```json theme={null}
{
  "data": {
    "id": "chg_018f8e2d9a5f7b10c3d4",
    "amount": 5000,
    "status": "PAID",
    "txid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f",
    "brCode": "00020126580014BR.GOV.BCB.PIX0136abc...6304ABCD",
    "imageBase64": "data:image/png;base64,iVBORw0KGgoAAAA...",
    "description": "Pedido #1234",
    "expiresAt": "2026-04-19T19:02:11.420Z",
    "paidAt": "2026-04-19T18:34:55.000Z",
    "end2endId": "E12345678202604191834550000000001",
    "customer": {
      "id": "cust_018f3a2b7c4d7c40a1b2",
      "name": "João Silva",
      "taxId": "12345678900",
      "email": "joao@exemplo.com",
      "phone": "+5511999999999"
    },
    "createdAt": "2026-04-19T18:32:11.420Z",
    "updatedAt": "2026-04-19T18:34:55.000Z"
  },
  "error": null,
  "success": true
}
```

<Tip title="Use webhooks em vez de polling" icon="webhook">
  Em vez de pollar este endpoint, cadastre um [webhook](/pages/webhooks/reference)
  e receba `CHARGE_PAID` no momento exato em que a cobrança é paga.
</Tip>


## OpenAPI

````yaml GET /transparents/check
openapi: 3.1.0
info:
  title: API Liquerapay
  description: |
    API pública da Liquerapay para criar cobranças PIX, processar saques,
    gerenciar clientes e receber eventos via webhooks.

    ## Versão Beta

    A v1 está em **beta**. Endpoints e payloads podem sofrer pequenas
    alterações antes da versão estável (1.0). Recomendamos travar a versão
    da sua integração no `package.json` / `requirements.txt` enquanto
    estivermos em beta.

    Não há ambiente de sandbox — todas as chamadas acontecem contra o
    ambiente de produção.

    ## Como começar

    1. Crie sua conta em [app.liquerapay.com](https://app.liquerapay.com)
    2. Gere uma chave de API no painel (`liq_...`)
    3. Faça sua primeira chamada em `https://api.liquerapay.com`
  version: 1.0.0-beta
  contact:
    name: Suporte Liquerapay
    url: https://liquerapay.com
  license:
    name: Proprietary
servers:
  - url: https://api.liquerapay.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Cadastre e gerencie os clientes da sua loja para reutilizar em cobranças.
  - name: Checkout Transparente
    description: >-
      Crie cobranças PIX (QR Code copia-e-cola) direto pela API e gerencie
      devoluções.
  - name: Withdrawals
    description: Solicite saques do saldo disponível para uma chave PIX.
  - name: Webhooks
    description: Cadastre URLs para receber eventos da Liquerapay em tempo real.
paths:
  /transparents/check:
    get:
      tags:
        - Checkout Transparente
      summary: Consultar cobrança
      description: |
        Retorna todos os detalhes de uma cobrança, incluindo `brCode`,
        `imageBase64`, `end2endId`, customer e timestamps.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
            example: chg_018f8e2d9a5f7b10c3d4
      responses:
        '200':
          description: Cobrança encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeDetailResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ChargeDetailResponse:
      type: object
      required:
        - data
        - error
        - success
      properties:
        data:
          $ref: '#/components/schemas/ChargeDetail'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    ChargeDetail:
      type: object
      required:
        - id
        - amount
        - status
        - txid
        - brCode
        - imageBase64
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          example: chg_018f8e2d9a5f7b10c3d4
        amount:
          type: integer
          example: 5000
        status:
          $ref: '#/components/schemas/ChargeStatus'
        txid:
          type: string
          example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f
        brCode:
          type: string
          example: 00020126580014BR.GOV.BCB.PIX0136abc...6304ABCD
        imageBase64:
          type: string
          example: data:image/png;base64,iVBORw0KGgoAAAA...
        description:
          type: string
          nullable: true
          example: Pedido
        expiresAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-19T19:02:11.420Z'
        paidAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-19T18:34:55.000Z'
        end2endId:
          type: string
          nullable: true
          description: >-
            Identificador único do PIX no Banco Central. Necessário para
            devoluções.
          example: E12345678202604191834550000000001
        customer:
          allOf:
            - $ref: '#/components/schemas/CustomerSummary'
          nullable: true
        createdAt:
          type: string
          format: date-time
          example: '2026-04-19T18:32:11.420Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-04-19T18:34:55.000Z'
    Error:
      type: object
      required:
        - error
        - message
        - success
      properties:
        error:
          type: string
          description: >-
            Código do erro (ex.: `VALIDATION_ERROR`, `UNAUTHORIZED`,
            `NOT_FOUND`).
          example: VALIDATION_ERROR
        message:
          type: string
          description: Mensagem amigável descrevendo o erro.
          example: 'amount: deve ser um número inteiro positivo'
        success:
          type: boolean
          enum:
            - false
          example: false
    ChargeStatus:
      type: string
      enum:
        - PENDING
        - PAID
        - EXPIRED
        - REFUNDED
        - DISPUTED
      description: |
        - `PENDING`: QR Code emitido, aguardando pagamento
        - `PAID`: pagamento confirmado
        - `EXPIRED`: passou do tempo limite sem pagamento
        - `REFUNDED`: cobrança paga foi devolvida integralmente
        - `DISPUTED`: há uma infração/MED aberta contra o pagamento
      example: PAID
    CustomerSummary:
      type: object
      required:
        - id
        - name
        - taxId
        - email
      description: Customer resumido, anexado a uma cobrança.
      properties:
        id:
          type: string
          example: cust_018f3a2b7c4d7c40a1b2
        name:
          type: string
          example: João Silva
        taxId:
          type: string
          description: CPF ou CNPJ (apenas números).
          example: '12345678900'
        email:
          type: string
          example: joao@exemplo.com
        phone:
          type: string
          nullable: true
          example: '+5511999999999'
  responses:
    Unauthorized:
      description: Falha de autenticação (token inválido, ausente ou revogado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: UNAUTHORIZED
            message: Token inválido ou ausente
            success: false
    Forbidden:
      description: Acesso negado para esta operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: FORBIDDEN
            message: Saques estão temporariamente bloqueados para este merchant
            success: false
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: NOT_FOUND
            message: Customer não encontrado
            success: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key ou JWT
      description: |
        Autentique suas requisições enviando o token no header
        `Authorization: Bearer <token>`.

        O token pode ser:

        - Uma **API key** com prefixo `liq_`, gerada em
          [Dashboard Liquerapay → Configurações → API Keys](https://app.liquerapay.com).
        - Um **JWT** retornado pelo login do dashboard (uso interno).

        Não há distinção de ambiente — toda chave vale para o único
        ambiente disponível (produção).

````