Estrutura
Uma cobrança PIX é representada pela seguinte estrutura:Atributos
string
Identificador único da cobrança no formato CUID.
string
Identificador da cobrança no seu sistema. Use para cruzar dados sem armazenar o
id interno. Deve ser único por projeto.integer
Valor da cobrança em centavos. Exemplo:
10000 = R$ 100,00.string
Nome ou descrição do produto/serviço cobrado. Aparece na notificação do PIX para o pagador.
string
Status atual da cobrança.
string
Código PIX copia-e-cola (Pix Payload Format Object). Disponível apenas quando
status é waiting_payment.date-time
Data e hora de expiração da cobrança. Após esse momento, o status muda para
expired.string | null
E-mail do comprador. Atalho direto ao campo
customer.email, disponível no nível raiz da transação.string | null
Nome do comprador. Atalho direto ao campo
customer.name, disponível no nível raiz da transação.object
Dados do comprador vinculado à cobrança. Consulte a entidade Customer.
date-time
Data e hora de criação da cobrança.
date-time
Data e hora da última atualização.
Próximos passos
Criar cobrança
Gere um PIX com valor, produto e dados do comprador.
Consultar status
Verifique o estado atual de uma cobrança.