Modelos

Objeto cobrança

O objeto cobrança é o mesmo na criação, na consulta, na listagem e dentro de dados dos webhooks de venda. Esta página é a referência única dele.

Exemplo

{
  "id": "8f2c4b1e9a7d4c3b8e1f2a3b4c5d6e7f",
  "status": "pendente",
  "valor": 9700,
  "taxa": 371,
  "liquido": 9329,
  "descricao": "Curso de Marketing",
  "pix_copia_e_cola": "00020101021226...",
  "link_pagamento": "https://app.grinnypay.com/pix?c=8f2c4b1e9a7d4c3b8e1f2a3b4c5d6e7f",
  "cliente": { "nome": "Carlos Silva", "email": "[email protected]" },
  "expira_em": "2026-10-15T14:45:00-03:00",
  "pago_em": null,
  "criado_em": "2026-10-15T14:30:00-03:00",
  "referencia": "pedido-1042",
  "livemode": true
}

Campos

idtexto

Identificador da cobrança: 32 caracteres, letras de a a f e números. Não muda nunca.

statustexto

Um de pendente, pago, expirado, falhou, med, contestado, reembolsado. Veja Status.

valorinteiro

Valor cobrado, em centavos. R$ 97,00 é 9700.

taxainteiro

Taxa da Grinny Pay sobre a venda, em centavos.

liquidointeiro

O que entra no seu saldo: valor menos taxa e menos a comissão de afiliado, se houver. Em centavos.

descricaotexto

Descrição que o comprador vê.

pix_copia_e_colatexto ou null

Código Pix (QR Code e "copia e cola"). Só vem enquanto o status é pendente; depois é null.

link_pagamentotexto

Página pronta de pagamento, com QR Code e contador.

clienteobjeto

nome e email de quem paga. O CPF e o celular que você manda na criação não voltam.

expira_emdata

Até quando o Pix pode ser pago (ISO 8601 com fuso).

pago_emdata ou null

Quando o pagamento foi confirmado. null se ainda não foi pago.

criado_emdata

Quando a cobrança foi criada.

livemodebooleano

true em cobrança de produção, false em cobrança criada com a chave de teste.

referenciatexto ou null

O código seu que você mandou ao criar (até 100 caracteres). null se não mandou.

Ciclo de vida

Uma cobrança nasce pendente e termina de um dos jeitos abaixo. Os eventos de webhook correspondentes estão em Webhooks de venda.

DeParaQuandoWebhook
pendentepagoO banco confirmou o Pix.venda.aprovada
pendenteexpiradoPassou o prazo (expira_em).venda.expirada
pagomedO banco do comprador abriu um MED.med.aberto
medpagoMED ganho.med.encerrado
medcontestadoMED perdido.med.encerrado e venda.contestada
pagoreembolsadoDevolução ao comprador.venda.reembolsada

Guarde o id da cobrança junto com o seu pedido. É ele que liga o pedido ao pagamento em consultas, webhooks e MED.