Referência

id:

{ "id": "clx7a8b9c0d1e2f3g4h5" }

id : string.
Identificador único da cobrança no formato CUID.

externalId:

{ "externalId": "pedido_123" }

externalId : string.
Identificador da cobrança no seu sistema. Use para cruzar dados sem armazenar o id interno. Deve ser único por projeto.

amountCents:

{ "amountCents": 10000 }

amountCents : integer.
Valor da cobrança em centavos. Exemplo: 10000 = R$ 100,00.

product:

{ "product": "Plano Premium" }

product : string.
Nome ou descrição do produto/serviço cobrado. Aparece na notificação do PIX para o pagador.

status:

{ "status": "waiting_payment" }

status : string.
Status atual da cobrança.

Status	Descrição
`waiting_payment`	Aguardando pagamento do cliente
`processing`	Pagamento recebido, aguardando confirmação
`paid`	Pagamento confirmado
`expired`	O tempo limite de pagamento foi excedido
`cancelled`	A cobrança foi cancelada
`refunded`	O valor foi devolvido ao cliente

pixCode:

{ "pixCode": "00020126580014br.gov.bcb.pix..." }

pixCode : string.
Código PIX copia-e-cola (Pix Payload Format Object). Disponível apenas quando status é waiting_payment.

expirationDate:

{ "expirationDate": "2026-02-28T10:00:00.000Z" }

expirationDate : date-time.
Data e hora de expiração da cobrança. Após esse momento, o status muda para expired.

customerEmail:

{ "customerEmail": "[email protected]" }

customerEmail : string | null.
E-mail do comprador. Atalho direto ao campo customer.email, disponível no nível raiz da transação.

customerName:

{ "customerName": "João Silva" }

customerName : string | null.
Nome do comprador. Atalho direto ao campo customer.name, disponível no nível raiz da transação.

customer:

{
  "customer": {
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900"
  }
}

customer : object.
Dados do comprador vinculado à cobrança. Consulte a entidade Customer.

createdAt:

{ "createdAt": "2026-02-28T09:00:00.000Z" }

createdAt : date-time.
Data e hora de criação da cobrança.

updatedAt:

{ "updatedAt": "2026-02-28T09:05:32.000Z" }

updatedAt : date-time.
Data e hora da última atualização.

Estrutura