Skip to content

API FastgivrReferência Técnica

Documentação completa de endpoints para desenvolvedores e sistemas integrando com a API FASTGIVR Invoices.


Bem-vindo à API Fastgivr

Nossa documentação é estruturada para fornecer uma referência clara e direta de todos os endpoints disponíveis.

Base URL ​

Prefixo base: https://developer-api.fastgivr.com.br

A API é subdividida em quatro grupos de rotas, cada um com seu prefixo:

GrupoPrefixoDescrição
Público / Geral/Enums, cobranças, clientes
Acesso/accessAutenticação, usuários, conta, tokens, notificações
Financeiro/consolidationDashboard, transações, extrato, saldo
Banking/bankingPix direto no banco: chaves, cobranças, copia e cola, transferências

Autenticação e Formato de Resposta ​

A API usa JWT (Bearer Token). O token é retornado no login e deve ser enviado em todas as requisições autenticadas:

http
Authorization: Bearer {token}

Endpoints que exigem uma conta ativa também aceitam o header opcional:

http
account: {account_id}
X-Account-Id: {account_id}

Se omitido, a primeira conta do usuário é selecionada automaticamente.

Estrutura de Resposta Padrão ​

json
{
  "data": { "id": 1, "status": "active" },
  "message": "Operação realizada com sucesso"
}
json
{
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100,
    "last_page": 7
  },
  "message": "Listagem carregada"
}
json
{
  "message": "Erro de validação",
  "errors": { 
    "campo": ["Detalhe do erro específico"]
  }
}

Módulos da API ​

Abaixo, encontre links rápidos para os principais módulos do sistema:


Outros Documentos ​