Skip to content

Enums ​

Listas de valores para montar filtros e telas. Rotas públicas: não exigem token nem header account.

Base URL: https://api.banking.fastgivr.com.br

GET /enums/charge-status ​

Status de cobrança (status_id de /billing/charges). Array, sem envelope.

json
[
  { "id": 1, "title": "pending", "description": "Pendente" },
  { "id": 2, "title": "paid", "description": "Pago" },
  { "id": 3, "title": "failed", "description": "Falhou" },
  { "id": 4, "title": "DELETED", "description": "Excluída" },
  { "id": 5, "title": "canceled", "description": "Cancelada" }
]

Os itens também trazem created_at e updated_at. Use o title para regras no seu código; o id pode variar entre ambientes.

GET /enums/payment-method ​

Métodos de pagamento de cobrança. Objeto valor → nome.

json
{ "PIX": "Pix", "BOLETO": "Boleto Bancário", "BOLEPIX": "Boleto com Pix", "UNKNOWN": "Desconhecido" }

UNKNOWN só aparece em cobranças com falha na emissão.

GET /enums/pix-status ​

Status do Pix de uma cobrança (data.pix.status). Objeto valor → nome.

json
{ "1": "PAID", "0": "PENDING", "-2": "DELETED", "3": "EXPIRED", "2": "PAIDWITHBOLETO" }

PAIDWITHBOLETO: a BOLEPIX foi paga pelo boleto.

GET /enums/boleto-status ​

Status do boleto de uma cobrança (data.boleto.status). Objeto valor → nome.

json
{ "0": "PENDING", "1": "PAID", "-5": "CANCELLED", "3": "EXPIRED", "4": "FAILED", "-1": "DELETED", "-2": "Deleted", "5": "PAIDWITHPIX" }

PAIDWITHPIX: a BOLEPIX foi paga pelo Pix. -5: baixado no banco.

GET /enums/status-clients ​

Classificações de cliente (status_id de /billing/clients). Array com id, title, created_at e updated_at.

json
[
  { "id": 1, "title": "Clientes Ativos" },
  { "id": 2, "title": "Clientes com Pagamentos em Aberto" },
  { "id": 3, "title": "Clientes em Alerta" },
  { "id": 4, "title": "Clientes Inadimplentes" }
]

GET /enums/webhook-type ​

Tipos dos webhooks recebidos dos bancos. Array [{ "value", "title" }].

valuetitle
1Pix
2Boleto
3Desconhecido
4TED (Entrada)
5Pix (Entrada)
6Pix (Saída)
7Pagamento de Boleto
8Recebimento de Boleto
9Listagem de Boletos
10TED (Saída)
20Abertura de Conta
21Recusa de Abertura de Conta
22Encerramento de Conta

GET /enums/webhook-status ​

Status de processamento dos webhooks recebidos dos bancos. Array [{ "value", "title" }].

valuetitle
0Pendente
1Erro de validação
2Sucesso
3Falha
4Duplicado
5Em processamento
6Expirado
7Aguardando
8Desconhecido
9Erro
10Boleto pendente
11Boleto em processamento
12Listagem de boleto registrada

Prompt para LLM ​

Copie o texto abaixo e cole no seu assistente de IA para ele integrar este módulo.

txt
Você vai integrar as listas de valores (enums) da API FastGivr.
Base URL: https://api.banking.fastgivr.com.br
Autenticação: nenhuma (rotas públicas).
Endpoints:
- GET /enums/charge-status — array [{ id, title (pending|paid|failed|DELETED|canceled), description }]. Use title nas regras; id varia entre ambientes.
- GET /enums/payment-method — objeto { "PIX": "Pix", "BOLETO": "Boleto Bancário", "BOLEPIX": "Boleto com Pix", "UNKNOWN": "Desconhecido" }.
- GET /enums/pix-status — objeto valor→nome: 0 PENDING, 1 PAID, 2 PAIDWITHBOLETO, 3 EXPIRED, -2 DELETED.
- GET /enums/boleto-status — objeto valor→nome: 0 PENDING, 1 PAID, 3 EXPIRED, 4 FAILED, 5 PAIDWITHPIX, -1 DELETED, -2 Deleted, -5 CANCELLED.
- GET /enums/status-clients — array [{ id, title }] das classificações de cliente.
- GET /enums/webhook-type e GET /enums/webhook-status — array [{ value, title }] (webhooks recebidos dos bancos).
Regras: as respostas de charge-status, payment-method, pix-status, boleto-status, status-clients, webhook-type e webhook-status vêm sem envelope; guarde em cache (mudam raramente).
Formato de resposta: { "code", "success", "data", "message" }; erro 422 traz os campos em "errors" ou "data".
Chame a API pelo servidor (CORS só libera os sites da FastGivr).
Gere o código <linguagem/stack do meu projeto> com tratamento desses erros.