1. Autenticação
Brasil Cash API
v3
  • main
  • v3
  • Gateway
    • Autenticação
      • Recebendo um token de acesso
        POST
    • Conta
      • Dados da conta
      • Listar transactions
      • Visualizar saldo na conta
    • Intenção de Pagamento
      • API de Pagamentos — Intenção de Pagamento (Payment Intent)
      • Iniciando TEF
      • Iniciando TED
      • Iniciando PIX Chave
      • Iniciando PIX QRCode
      • Iniciando PIX Manual
      • Confirmando Intenção de Pagamento
      • Lendo dados QRCode
      • Listando Intenção de Pagamentos
      • Detalhe de uma Intenção de Pagamento
    • QRCode
      • Criando um QRCode PIX
      • Static QRCODE
      • Detalhe de um QRCode
      • Inativando um QRCode
    • PIX Dict
      • Listando Chaves PIX
      • Criando Chave PIX
      • Cancelamento de Chave PIX
    • MED
    • Webhooks
  • BaaS
    • BrasilCash BaaS — API do Parceiro (v1)
    • Onboardings
      • Listar Onboardings
      • Criar link de onboarding
    • Contas
      • Listar Contas
      • Detalhar Conta
      • Criar credencial para uma conta
  • Esquemas
    • PIX
      • ReceiverPayer
      • Pix Initiate
      • Pix Consulta
      • Paginação
    • Pagador/Recebedor
    • ApplicationError
  1. Autenticação

Recebendo um token de acesso

BaaS API
https://api.brasilcash.com.br/baas
BaaS API
https://api.brasilcash.com.br/baas
POST
v3/auth

Autenticação#

Toda chamada usa um token JWT de sessão, obtido em POST /auth com as credenciais da sua chave de API.
Ao criar uma chave de API você recebe quatro valores, exibidos uma única vez: clientId, clientSecret, username e password. Guarde-os em um cofre de segredos. Não é possível recuperá-los depois, apenas gerar novos.
A resposta traz o token JWT da sessão. Envie-o nas demais chamadas, no header Authorization: Bearer <token>.
Antes de usar a chave, três regras valem:
Toda chave nova entra em análise do time de segurança, que libera os IPs de origem manualmente. Chamadas de outros IPs são recusadas.

Requisição

Authorization
Envie suas requisições HTTP com um cabeçalho
Authorization
que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password
Exemplo:
Authorization: Basic *****************
Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.brasilcash.com.br/baasv3/auth' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
    "username":"{{username}}",
    "password":"{{password}}"
}'
Response Response Example
{
    "expires_in": "2022-02-02T11:18:25.1362173-03:00",
    "token_type": "Bearer",
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6WyJkMjAzZDdjNi03MzhiLTRlMTQtYjVmMi1mMzg2M2M0ZDIwYzYiLCJkMjAzZDdjNi03MzhiLTRlMTQtYjVmMi1mMzg2M2M0ZDIwYzYiXSwianRpIjoiNzkyMzQ4OWVhZmQ5NGMxNDkyNzFiM2E4ZmIxNzU4ODgiLCJicmFuY2hJZCI6IjMiLCJuYmYiOjE2NDM4MTEyMDUsImV4cCI6MTY0MzgxMTUwNSwiaWF0IjoxNjQzODExMjA1LCJpc3MiOiJpc3MtYmFuay5iY3BhZy5jb20uYnIiLCJhdWQiOiJiY3BhZy1iYW5rLWlzcyJ9.dKRYVrcxdzsv-0u3530Y-_s96vmAKqbiQ92tCC9-5XCyA689C8rFOBekUVAWWGIjTD2J4s7TfYZ6_ke_ZfSUVkZ3z-JyaLApG-BxUB9a54o8yABNvIGvx49RaGtm51xRwKhes_nioCaYNyaXjc-knSBRmnw70QNjMDhOoeCEVlrMfNVEdqh0wN2nbE0n_CsMjZKqWkFwplsMYpsaoiBNbqNCSiKmfHP-WCE1uJrliC710gqzPh66NNGDRIXqUXYdfk3p6an64WUR8LkCK4cA3Tx6nbnjcstyoNEs6dvxnrKq9qtkKy8IIaPLYNoCtn6LJqfpF-F2T-w6r0JTaas"
}
Modificado em 2026-10-20 16:30:04
Página anterior
Autenticação
Próxima página
Dados da conta
Built with