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

# Consultar cobrança

> Retorna uma cobrança pelo id. O `postbackSecret` **não** é retornado aqui — só na criação.

Escopo exigido: `charges:read`.



## OpenAPI

````yaml /openapi.json get /v1/charges/{id}
openapi: 3.1.0
info:
  title: Gravity Play API
  version: 1.0.0
  description: >-
    API para criar cobranças, receber pagamentos e ler cursos, turmas, alunos e
    progresso da área de membros. Cada chave de API tem escopos; cada operação
    indica o escopo que exige.
servers:
  - url: https://api.sandbox.gravitypay.app
    description: Sandbox (testes) — alvo do try-it
  - url: https://api.gravitypay.app
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cobranças
    description: Cobranças avulsas com link de pagamento.
  - name: Pagamentos
    description: Vendas da loja e vendedores.
  - name: Assinaturas
    description: Assinaturas da loja, com dados do cliente. Exige `subscriptions:read`.
  - name: Cursos
    description: Cursos da área de membros, com módulos e aulas.
  - name: Turmas
    description: Turmas dos cursos.
  - name: Alunos
    description: 'Alunos, matrículas e progresso. Dado pessoal: exige `students:read`.'
paths:
  /v1/charges/{id}:
    get:
      tags:
        - Cobranças
      summary: Consultar cobrança
      description: >-
        Retorna uma cobrança pelo id. O `postbackSecret` **não** é retornado
        aqui — só na criação.


        Escopo exigido: `charges:read`.
      operationId: getCharge
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Cobrança
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Charge'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Charge:
      type: object
      properties:
        id:
          type: string
          example: chg_2e59538f...
        object:
          type: string
          example: charge
        status:
          type: string
          enum:
            - pending
            - paid
            - failed
            - refunded
            - canceled
        amountInCents:
          type: integer
        currency:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/ChargeItem'
        description:
          type: string
          nullable: true
        customer:
          type: object
          properties:
            email:
              type: string
              nullable: true
            name:
              type: string
              nullable: true
        metadata:
          type: object
          additionalProperties: true
        checkoutUrl:
          type: string
        postbackSecret:
          type: string
          description: Retornado apenas na criação.
        createdAt:
          type: string
          format: date-time
    ChargeItem:
      type: object
      required:
        - name
        - quantity
        - unitAmountInCents
      properties:
        name:
          type: string
        quantity:
          type: integer
          minimum: 1
        unitAmountInCents:
          type: integer
          minimum: 0
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              description: >-
                `authentication` (401), `insufficient_scope` (403),
                `invalid_request` (400) ou `not_found` (404).
            message:
              type: string
            param:
              type: string
              description: Parâmetro que falhou, em `invalid_request`.
            requiredScope:
              type: string
              description: Escopo que falta, em `insufficient_scope`.
  responses:
    Error:
      description: Erro
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InsufficientScope:
      description: A chave é válida, mas não tem o escopo exigido pela operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: insufficient_scope
              message: Esta chave de API não tem o escopo students:read.
              requiredScope: students:read
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````