Comece por aqui

Introdução

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.

URL base

Todas as chamadas vão para o endereço abaixo, sempre por https://:

https://app.grinnypay.com/api/v1

O caminho de cada endpoint é somado à URL base. Exemplo: POST /charges vira https://app.grinnypay.com/api/v1/charges.

Formato

  • Pedidos e respostas em JSON (Content-Type: application/json).
  • Valores de dinheiro sempre em centavos e números inteiros: R$ 97,00 é 9700.
  • Datas no padrão ISO 8601 com fuso, por exemplo 2026-10-15T14:30:00-03:00.
  • Campos e códigos em português: valor, status, pendente, pago.
  • Toda resposta de erro tem o mesmo formato. Veja Erros.

O que dá pra fazer

EndpointPara quêPermissão da chave
POST /chargesCriar cobrança PixTransações
GET /charges/{id}Consultar uma cobrançaTransações
GET /chargesListar cobrançasTransações
GET /balanceConsultar saldoConta
POST /withdrawalsCriar saqueSaques
GET /withdrawals/{id}Consultar um saqueSaques
GET /withdrawalsListar saquesSaques

Além disso, a Grinny Pay manda webhooks para o seu servidor quando algo acontece (Pix pago, expirado, MED aberto, saque concluído).

Para ferramentas e IAs

  • openapi.yaml: o contrato da API em OpenAPI 3.1. Abre no Swagger, no Postman e gera cliente em qualquer linguagem.
  • llms.txt: lista de todas as páginas, para assistentes de IA. llms-full.txt traz a documentação inteira num arquivo só.

Antes de começar

  • Sua conta precisa estar aprovada. Conta em análise recebe 403 conta_nao_aprovada.
  • A aba Integrações › API do painel só abre com a verificação em duas etapas (2FA) ligada.
  • Chave gp_live_ cria Pix real. Para testar sem dinheiro de verdade, use a chave gp_test_: veja Modo de teste.

Comece pelo guia Sua primeira cobrança: do zero ao Pix pago e ao webhook recebido.