Introdução às APIs da BYX

Bem-vindo à documentação oficial das APIs da BYX!

Aqui você encontra tudo o que precisa para integrar com nossos serviços de forma rápida, segura e 100% digital. Nossas APIs são pensadas para escalar sua operação, seja no crédito consignado, cartão ou banking as a service.


📌 O que você pode fazer com a API da BYX?

  • Oferecer empréstimo consignado público (INSS)
  • Integrar empréstimo consignado privado (convênios e empresas)
  • Emitir e gerenciar cartão consignado e cartão benefício consignado
  • Acessar soluções completas de Banking as a Service, como:
    • Motor de crédito
    • Conciliação
  • Receber atualizações em tempo real com webhooks de status
  • Usar funcionalidades exclusivas para canais digitais, como WhatsApp e app

🔐 Autenticação

Todas as requisições devem ser autenticadas via Bearer Token.

Para obter seu token, envie uma requisição com suas credenciais:

POST /auth/token
Authorization: Basic {client_id}:{client_secret}
Content-Type: application/json