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

# Get Charge

> Consulta os detalhes de uma cobrança avulsa pelo paymentId, incluindo status, cliente, metadata e datas. Use para confirmar o pagamento (polling) como alternativa ao webhook do callbackUrl. Cobranças com split (prefixo psplit_) retornam o formato descrito em GET /v1/split-charges/{paymentId}.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/charges/{paymentId}
openapi: 3.1.0
info:
  title: PurinCash API
  version: 1.0.0
servers:
  - url: https://api.purincash.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cartao
    description: Pagamentos no cartao de credito.
  - name: Cobrancas
    description: Cobrancas PIX avulsas com valor livre.
  - name: Entregas
    description: Conteudo entregue automaticamente apos o pagamento.
  - name: Disputas
    description: Contestacoes (MED) e envio de evidencias.
  - name: Pagamentos
    description: Pagamentos PIX e LTC vinculados ou nao a um produto.
  - name: Saques
    description: Saques em PIX, LTC e USDT.
  - name: Produtos
    description: Produtos de cobranca criados pela API.
  - name: Sandbox
    description: Simulacao de pagamentos e saldo de teste.
  - name: Splits
    description: Cobrancas divididas entre varias contas.
  - name: Loja
    description: Produtos da loja do Discord (somente leitura).
  - name: Assinaturas
    description: PIX recorrente.
  - name: Carteira
    description: Saldo, retencoes e valores a liberar.
paths:
  /v1/charges/{paymentId}:
    get:
      tags:
        - Cobrancas
      summary: Get Charge
      description: >-
        Consulta os detalhes de uma cobrança avulsa pelo paymentId, incluindo
        status, cliente, metadata e datas. Use para confirmar o pagamento
        (polling) como alternativa ao webhook do callbackUrl. Cobranças com
        split (prefixo psplit_) retornam o formato descrito em GET
        /v1/split-charges/{paymentId}.
      operationId: getCharge
      parameters:
        - name: paymentId
          in: path
          required: true
          description: Identificador da cobrança (ex. psc_a1b2c3d4...).
          schema:
            type: string
      responses:
        '200':
          description: Detalhes da cobrança.
          content:
            application/json:
              schema:
                type: object
                properties:
                  paymentId:
                    type: string
                    description: Identificador único da cobrança (prefixo psc_).
                  status:
                    type: string
                    enum:
                      - pending
                      - paid
                      - expired
                      - refunded
                    description: Status atual da cobrança.
                  amountCents:
                    type: integer
                    description: Valor da cobrança em centavos.
                  currency:
                    type: string
                    description: Moeda da cobrança (sempre BRL).
                  description:
                    type: string
                    description: Descrição informada na criação.
                  customer:
                    type: object
                    description: Dados do cliente informados na criação.
                    properties:
                      name:
                        type: string
                        description: Nome do cliente.
                      email:
                        type: string
                        description: E-mail do cliente.
                      externalId:
                        type: string
                        description: Identificador do cliente no seu sistema.
                  metadata:
                    type: string
                    description: String JSON livre enviada na criação.
                  paidAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Data de confirmação do pagamento (null enquanto pendente).
                  expiresAt:
                    type: string
                    format: date-time
                    description: Data de expiração da cobrança.
                  createdAt:
                    type: string
                    format: date-time
                    description: Data de criação da cobrança.
              example:
                paymentId: psc_a1b2c3d4...
                status: paid
                amountCents: 1200
                currency: BRL
                description: Pagamento PIX
                customer:
                  name: ''
                  email: ''
                  externalId: ''
                metadata: '{}'
                paidAt: '2026-03-18T12:05:00.000Z'
                expiresAt: '2026-03-18T12:30:00.000Z'
                createdAt: '2026-03-18T12:00:00.000Z'
        '401':
          description: Chave de API ausente, inválida ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid or revoked API key
        '404':
          description: >-
            Cobrança não encontrada para esta conta neste ambiente
            (live/sandbox).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Charge not found
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: >-
            Mensagem de erro legivel. Trate pelo codigo HTTP; o texto pode
            mudar.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

````