Tema
Referência da API
Esta seção é para desenvolvedores que ligam o sistema da empresa (ERP, loja, sistema próprio) à FastGivr pela API.
Manual × referência
- O manual mostra as telas do portal: criar o usuário de API, ver a chave da conta, acompanhar e reenviar webhooks. Comece por Tokens de API e webhooks.
- Esta referência mostra as chamadas HTTP que o seu sistema faz: endereços, campos, respostas e erros.
O que dá para fazer pela API
| Tarefa | Página |
|---|---|
| Pegar o token de acesso | Autenticação |
| Criar, consultar, alterar e apagar cobranças (Pix, Boleto e BolePix) | Cobranças |
| Criar e acompanhar links de pagamento | Links de pagamento |
| Cadastrar e consultar clientes | Clientes |
| Evitar cobrança duplicada em novas tentativas | Idempotência |
| Receber o aviso de pagamento no seu sistema | Webhooks |
| Entender os códigos de erro | Erros |
Texto para IA (LLMs)
Vai usar um assistente de IA para escrever a integração? Dê a ele um destes arquivos (em inglês). Eles explicam só o token, as cobranças e os links de pagamento.
- llms.txt: o resumo, com a lista das chamadas.
- llms-full.txt: tudo, com campos, respostas e exemplos.
Pix out não faz parte da integração
Enviar Pix, transferir ou pagar contas pela API não pode ser integrado. Os textos para IA mandam recusar esses pedidos.
Endereço base
text
https://v1.api.fastgivr.com.brTodos os caminhos desta referência são relativos a esse endereço. Não existe prefixo /api. Exemplo: POST https://v1.api.fastgivr.com.br/billing/charges.
Ambiente de testes
Informação ainda não publicada — fale com o suporte antes de testar a integração. As cobranças criadas neste endereço são reais.
Formato
- Envie e receba JSON (
Content-Type: application/json). - Toda chamada, menos a do token, leva o cabeçalho
Authorization: Bearer SEU_TOKEN_DE_ACESSO. Veja Autenticação. - Valores em reais, com ponto decimal:
150.90. - Datas de entrada no formato
AAAA-MM-DD:2026-11-30. - As mensagens de erro vêm em português.
Confira o status HTTP
Algumas respostas trazem o campo success, mas nem todas. Para saber se deu certo, use sempre o status HTTP (2xx = sucesso). Veja Erros.
Antes de começar
- Crie um usuário de API no portal: Como criar um usuário de API.
- Copie a chave da conta (Account Token) na tela Tokens de API: Tokens de API e webhooks.
- Guarde a chave e o e-mail do usuário de API em um cofre de segredos do seu sistema, nunca no código-fonte.
A chave da conta é um segredo
Quem tem a chave e o e-mail de um usuário de API cria cobranças na sua conta. Nunca coloque a chave em aplicativo de celular, site ou código que roda no navegador do cliente. Use a chave só no seu servidor.
Fluxo típico
- O seu sistema pede um token em
POST /access/account/get-token. - Cria a cobrança em
POST /billing/charges, com o campowebhook. - Mostra ao cliente o QR Code Pix ou o boleto que voltou na resposta.
- Recebe o aviso no endereço do
webhookquando o Pix é pago. - Confirma o pagamento consultando
GET /billing/charges/{id}antes de dar baixa.
Limites de uso, versões e bibliotecas
- Limite de chamadas por minuto: informação ainda não publicada — fale com o suporte.
- Política de versões da API: informação ainda não publicada — fale com o suporte.
- Bibliotecas prontas (SDK): não há. Use qualquer cliente HTTP.