Copy page

Desenvolvedores

API REST da Fluxis

A API REST da Fluxis permite autenticar, gerenciar contas e pontos de venda, criar solicitações de pagamento e receber notificações webhook. Esta página orienta você; a referência interativa está em /api.

URLs base

Ambiente	Host
Staging	https://api.stgfluxis.us
Production	https://api.fluxis.us

Todos os endpoints têm o prefixo /v1.

Autenticação

Cada requisição protegida exige ambos os cabeçalhos:

Code
Authorization: Bearer <access_token>
x-fluxis-api-key: <your_api_key>

Obtenha um token trocando sua chave e segredo de API:

POST /v1/auth/token

Consulte Authentication na referência da API.

Recursos principais

Recurso	Finalidade	Referência
Accounts	Contas de comerciante, endereços de liquidação	/api — Accounts
Point of Sale	Pontos de entrada de pagamento, solicitações de pagamento	/api — Point of Sale
Webhooks	Notificações de eventos em nível de conta	/api — Webhooks
Transactions	Conciliação e relatórios	/api — Transactions
NASPIP	Ler ou criar tokens NASPIP	/api — NASPIP Token

Fluxo de integração típico

1. Autenticação — POST /v1/auth/token
2. Descoberta de recursos — GET /v1/account, GET /v1/pos?page=1&page_size=20
3. Criar pagamentos — POST /v1/pos/{posID}/payment-request (ou payment-request-checkout para checkout hospedado)
4. Receber atualizações — Registre POST /v1/account/{accountID}/webhook com event_type: payment_request
5. Conciliar — GET /v1/transactions?page=1&page_size=50 ou faça polling de GET /v1/pos/{posID}/payment-request/{paymentRequestID}

Passo a passo: Guia de integração API.

Paginação

Endpoints de listagem usam os parâmetros de consulta page e page_size (não offset/limit):

• POS: page ≥ 1, page_size 1–100
• Transactions: page ≥ 1, page_size 5–100
• Webhook logs: page ≥ 1, page_size 5–20

As respostas incluem { data, total, page, page_size, total_pages }.

Webhooks

Webhooks são registrados por conta, não por POS. A Fluxis assina as entregas com HMAC-SHA256.

• Visão geral de webhooks — Registro e comportamento de entrega
• Verificação de assinatura de webhook — JSON canônico e fluxo de teste

Valores event_type suportados: payment_request, incoming_transfer, refund.

Explorar a API

Guias relacionados

• Guia de integração API
• Criar e monitorar solicitações de pagamento
• Webhooks
• Verificação de assinatura de webhook
• SDKs (em breve)