Bem-vindo à API da FortalPay

Integre cobranças Pix, checkouts e os recursos do seu negócio com uma API simples e segura.

A documentação para integrar a FortalPay ao seu sistema, criar experiências de pagamento e gerenciar os dados do seu negócio.

Faça sua primeira requisição

Configure sua API key e valide a integração em poucos passos.

Explore a referência da API

Consulte endpoints, parâmetros, exemplos e respostas.

---

O que é a FortalPay?

A FortalPay oferece uma API para criar cobranças Pix e páginas de checkout hospedadas. Clientes, produtos e cupons podem ser gerenciados pela mesma integração, enquanto webhooks notificam seu sistema sobre eventos de pagamento.

Uma requisição mínima para criar um checkout usa os produtos cadastrados no seu catálogo:

curl --request POST 'https://api.fortalpay.com/v1/checkouts' \
  --header 'Authorization: ApiKey fpay_sk_test_...' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "quantity": 1
      }
    ]
  }'

Princípios da API

Previsível

Recursos organizados em endpoints HTTP versionados, como POST /v1/checkouts.

Consistente

Respostas seguem o envelope { data, success, error } em toda a API.

Segura

API keys autenticam as chamadas e webhooks usam assinatura HMAC-SHA256.

---

O que você pode fazer

Receber via Pix

Crie cobranças Pix idempotentes e consulte os pagamentos do seu negócio.

Criar checkouts

Gere páginas de pagamento hospedadas e redirecione seus clientes.

Gerenciar clientes

Cadastre, consulte, filtre e remova clientes da sua integração.

Organizar produtos

Mantenha um catálogo de produtos para usar em cobranças e checkouts.

Aplicar cupons

Crie descontos percentuais ou fixos com validade e limite de uso.

Receber webhooks

Acompanhe eventos em tempo real com entregas identificadas e assinadas.

---

Primeiros passos

1. Crie uma API key

Gere uma credencial de sandbox ou produção e armazene-a com segurança.

2. Faça uma requisição

Autentique sua aplicação e confirme o acesso à API.

3. Conheça as convenções

Entenda autenticação, ambientes, paginação e envelopes de resposta.

4. Crie um checkout

Use os recursos cadastrados para iniciar sua primeira experiência de pagamento.

Use chaves fpay_sk_test_... durante o desenvolvimento e fpay_sk_live_... somente em produção. Chamadas de escrita exigem uma API key com acesso FULL_ACCESS.