Consultar cobrança
GET
/api/v1/charges/{id}Devolve uma cobrança da sua conta pelo id. Permissão: Criar/consultar transações.
Parâmetros
idtexto (no caminho)obrigatórioO id que veio ao criar a cobrança (32 caracteres).
Se a cobrança ainda está pendente, a consulta pergunta ao banco na hora se ela foi paga (no máximo a cada 20 segundos por cobrança). Mesmo assim, o jeito certo de saber do pagamento é o webhook.
Exemplo
curl https://app.grinnypay.com/api/v1/charges/8f2c4b1e9a7d4c3b8e1f2a3b4c5d6e7f \
-H "Authorization: Bearer $GRINNY_KEY"<?php
$ch = curl_init('https://app.grinnypay.com/api/v1/charges/8f2c4b1e9a7d4c3b8e1f2a3b4c5d6e7f');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('GRINNY_KEY')],
]);
$cobranca = json_decode(curl_exec($ch), true);const resp = await fetch('https://app.grinnypay.com/api/v1/charges/8f2c4b1e9a7d4c3b8e1f2a3b4c5d6e7f', {
headers: { Authorization: `Bearer ${process.env.GRINNY_KEY}` },
});
const cobranca = await resp.json();Resposta 200
O objeto cobrança, igual ao da criação, com o status de agora.
{
"id": "8f2c4b1e9a7d4c3b8e1f2a3b4c5d6e7f",
"status": "pago",
"valor": 9700,
"taxa": 371,
"liquido": 9329,
"descricao": "Curso de Marketing",
"pix_copia_e_cola": null,
"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": "2026-10-15T14:32:08-03:00",
"criado_em": "2026-10-15T14:30:00-03:00",
"referencia": "pedido-1042"
}Cobrança que não existe (ou é de outra conta): 404 nao_encontrado.
Exemplos de resposta de erro
{
"erro": {
"codigo": "nao_encontrado",
"mensagem": "Cobrança não encontrada."
}
}