Charge Object

Estrutura completa do objeto Charge retornado pela API.

Propriedades

Propriedade Tipo Descrição
id string ID único da cobrança (formato: ci_123)
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 da adquirente
  • emv - Código PIX copia e cola (sempre presente)
  • qr_code_image_url - URL da imagem do QR Code (opcional)
  • expires_at - Data de expiração
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)