BS FinanceBS Finance / Docs

Introdução

A API da BS Finance é a porta de entrada para construir produtos financeiros completos: contas digitais, Pix (cobranças, pagamentos, devoluções, recorrências), boletos, transferências internas e tratamento de infrações. Tudo via REST sobre HTTPS, com autenticação OAuth2 e respostas em JSON.

URL base

Todas as chamadas usam HTTPS e seguem o padrão:

https://api.pix.nixfin.com.br

Primeiros passos

  1. Solicite suas credenciais de sandbox falando com o time comercial da BS Finance.
  2. Gere um token de acesso com o fluxo OAuth2 client credentials.
  3. Faça sua primeira chamada autenticada (consulta de saldo é o "hello world").
  4. Configure webhooks para receber eventos em tempo real.

Convenções

  • Datas seguem o padrão ISO 8601 em UTC.
  • Valores monetários em endpoints de conta vão em centavos (inteiros). Em endpoints Pix oficiais, seguem o padrão Bacen como string "150.00".
  • Identificadores internos são UUIDs v4. Identificadores Pix (txid, end-to-end ID) seguem o padrão Bacen.
  • Toda operação financeira deve incluir o header Idempotency-Key para evitar débitos duplicados.

Próximo

Autenticação