Charge Object

Estrutura completa do objeto Charge retornado pela API.

Propriedades

Propriedade Tipo Descrição
id string Identificador único e opaco da cobrança. Formato: ci_ seguido de 12 caracteres alfanuméricos aleatórios (ex: ci_k7m2p9xr4nqs). Use este ID para todas as operações na API (consultar, reembolsar, cancelar). Não é sequencial.
status string Status da cobrança (pending, paid, expired, failed, refunded)
amount integer Valor em centavos
currency string Moeda (BRL)
payment_method string Método de pagamento (pix, card, boleto)
customer object Dados do cliente (id, name, email, document, phone) - opcional
external_id string ID externo para rastreamento (opcional)
metadata object Metadados customizados (opcional)
items array Itens da transação
pix object Detalhes PIX (se payment_method = pix):
  • txid — Transaction ID emitido pela adquirente e registrado no sistema bancário (Banco Central). Imutável. Recomendado armazenar para reconciliação e como fallback de identificação em callbacks.
  • emv — Código PIX copia e cola. Sempre presente.
  • qr_code_image_url — URL da imagem do QR Code (opcional, dependente da adquirente)
  • expires_at — Data/hora de expiração (ISO 8601)
card object Detalhes do cartão (se payment_method = card)
boleto object Detalhes do boleto (se payment_method = boleto)
created_at string Data de criação (ISO 8601)
updated_at string Data de atualização (ISO 8601)