# API Grinny Pay > API REST para criar cobranças Pix, consultar saldo e saques, e receber webhooks. Valores em centavos, JSON, chave Bearer. Esta lista tem todas as páginas da documentação. ## Guias · Comece por aqui - [Introdução](https://app.grinnypay.com/docs?p=introducao): Com a API da Grinny Pay o seu sistema cria cobranças Pix, consulta vendas, saldo e saques, e recebe avisos em tempo real quando um Pix é pago. - [Sua primeira cobrança](https://app.grinnypay.com/docs?p=primeira-cobranca): Do zero ao Pix pago: chave de API, cobrança, QR Code para o cliente e o aviso de pagamento no seu servidor. - [Autenticação](https://app.grinnypay.com/docs?p=autenticacao): Toda chamada leva a sua chave privada no cabeçalho Authorization. As chaves são criadas no painel, em Integrações › API. - [Modo de teste (sandbox)](https://app.grinnypay.com/docs?p=sandbox): Teste a integração inteira, do pedido ao webhook, sem Pix de verdade e sem mexer no seu saldo. Basta usar uma chave de teste no lugar da chave de produção. - [Limites e repetição segura](https://app.grinnypay.com/docs?p=limites): Limites de pedidos que protegem a sua conta e a plataforma, e como repetir um pedido sem criar nada em dobro. - [Erros](https://app.grinnypay.com/docs?p=erros): Todo erro volta com um status HTTP e um JSON com o codigo (fixo, para o seu sistema tratar) e a mensagem (texto em português, pode mudar). - [Status](https://app.grinnypay.com/docs?p=status): Os status que a API devolve no campo status de cobranças e saques. ## Guias · Modelos - [Objeto cobrança](https://app.grinnypay.com/docs?p=modelo-cobranca): 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. - [Objeto saque](https://app.grinnypay.com/docs?p=modelo-saque): O objeto saque é o mesmo na criação, na consulta e na listagem da API. O webhook de saque usa um formato mais enxuto (veja o aviso no fim). ## Guias · Boas práticas - [Conciliar pagamentos](https://app.grinnypay.com/docs?p=conciliacao): O webhook é o jeito principal de saber do pagamento. A conciliação é a rede de segurança: uma rotina sua que confere de tempos em tempos se nenhuma venda ficou sem tratar. - [Antes de ir pra produção](https://app.grinnypay.com/docs?p=producao): Uma lista para conferir antes de receber vendas de verdade. Teste primeiro com a chave gp_test_ (Modo de teste), que não cria Pix de verdade. Com a chave de produção todo Pix é real: faça os testes abaixo com valores pequenos. ## Referência · Cobranças - [Criar cobrança Pix](https://app.grinnypay.com/docs?p=criar-cobranca): Cria uma cobrança Pix avulsa, com valor livre. Permissão: Criar/consultar transações. - [Consultar cobrança](https://app.grinnypay.com/docs?p=consultar-cobranca): Devolve uma cobrança da sua conta pelo id. Permissão: Criar/consultar transações. - [Listar cobranças](https://app.grinnypay.com/docs?p=listar-cobrancas): Lista as cobranças da sua conta, da mais nova para a mais antiga. Permissão: Criar/consultar transações. - [Simular pagamento (teste)](https://app.grinnypay.com/docs?p=simular-pagamento): Marca uma cobrança de teste como paga e dispara o webhook venda.aprovada. Só existe com a chave de teste (gp_test_); veja o guia do modo de teste. ## Referência · Conta - [Consultar saldo](https://app.grinnypay.com/docs?p=saldo): Mostra o saldo da sua conta. Permissão: Consultar dados da conta e saldo. ## Referência · Saques - [Criar saque](https://app.grinnypay.com/docs?p=criar-saque): Pede um saque do seu saldo disponível: para a sua conta bancária cadastrada ou para uma chave Pix de outra pessoa. Permissão: Criar/consultar saques. - [Consultar saque](https://app.grinnypay.com/docs?p=consultar-saque): Devolve um saque da sua conta pelo número. Permissão: Criar/consultar saques. - [Listar saques](https://app.grinnypay.com/docs?p=listar-saques): Lista os saques mais recentes da sua conta. Permissão: Criar/consultar saques. ## Webhooks · Webhooks - [Como funcionam](https://app.grinnypay.com/docs?p=webhooks): Webhook é um aviso que a Grinny Pay manda para o seu servidor quando algo acontece: Pix gerado, Pix pago, MED aberto, saque concluído. Assim você não precisa ficar consultando a API. - [Todos os eventos](https://app.grinnypay.com/docs?p=webhooks-eventos): Todos os eventos que o seu servidor pode receber. Cada família tem uma página com a tabela de campos e o JSON completo de cada evento. ## Webhooks · Eventos por família - [Venda](https://app.grinnypay.com/docs?p=webhooks-venda): Eventos de venda: o Pix foi gerado, pago, venceu, foi devolvido ou contestado. Em todos eles dados é o objeto cobrança, como estava no momento do evento. - [MED](https://app.grinnypay.com/docs?p=webhooks-med): MED é o pedido de devolução que o banco do comprador abre (fraude ou golpe). O valor da venda fica bloqueado no seu saldo até a decisão. Aqui dados descreve a disputa, não a cobrança. - [Saque](https://app.grinnypay.com/docs?p=webhooks-saque): Eventos de saque: o dinheiro saiu ou o saque não foi realizado. Valem para saques pedidos pelo painel e pela API. - [Teste (teste.ping)](https://app.grinnypay.com/docs?p=webhooks-teste): Para conferir se o seu endereço recebe e valida os avisos antes de uma venda de verdade, use o botão Testar do webhook no painel (Integrações › Webhooks). ## Webhooks · Receber com segurança - [Conferir a assinatura](https://app.grinnypay.com/docs?p=webhooks-assinatura): Todo webhook vem assinado. Confira a assinatura antes de confiar no conteúdo: assim ninguém finge ser a Grinny Pay para liberar um acesso. - [Receptor completo](https://app.grinnypay.com/docs?p=webhooks-exemplo): Um receptor completo, do pedido chegando até a resposta: confere a assinatura, ignora evento repetido, ignora evento atrasado e responde rápido. Copie e troque só o trecho "libere o acesso". - [Entrega e reenvio](https://app.grinnypay.com/docs?p=webhooks-reentregas): O que acontece quando o seu servidor não responde, quando o mesmo aviso chega duas vezes e como reenviar um aviso pelo painel. ## Arquivos - [OpenAPI 3.1](https://app.grinnypay.com/docs/openapi.yaml): contrato completo das rotas - [Documentação inteira em um arquivo](https://app.grinnypay.com/docs/llms-full.txt)