1. Gateway
Brasil Cash API
v3
  • main
  • v3
  • Gateway
    • Autenticação
      • Recebendo um token de acesso
    • 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. Gateway

Autenticação

Para começar a utilizar nossos serviços de API é necessário obter o token de acesso, para isso é necessário entrar em contato com nosso time comercial, solicitando o produto de API.

Entendo as chaves de acesso#

Após recebido um e-mail contendo as chaves de acesso, você receberá os seguintes dados.
chavedescrição
api-keyChave de api para obter o token de acesso
api-secretChave secreta para obter o token de acesso
usernameUsuário de acesso para autenticação na API.
passwordSenha de acesso para a autenticação na API.

Utilizando chaves de acesso#

Para utilizar qualquer serviço de nossa API, é necessário estar autenticado utilizando as chaves de acesso.
A chave de acesso deve ser utilizada na requisição POST para receber o token de acesso.
A api-key e a api-secret devem ser enviado como basic auth.

Construíndo o valor basic auth#

Para construir um hash basic auth é necessário converter para base64 a {api-key}:{api-secret}.
Exemplo:

Dados os valores de api-key e api-secret abaixo:
api-key: ddea9355-1cb9-4998-9beb-e4b39ce5a334
api-secret: 115f524f-d7ba-4b46-a161-a82a96ad28db
Montando o valor para Base64 válido
ddea9355-1cb9-4998-9beb-e4b39ce5a334:115f524f-d7ba-4b46-a161-a82a96ad28db
Convertendo para base64
Pode utilizar qualquer conversor para base 64
Será obtido o seguinte valor:
ZGRlYTkzNTUtMWNiOS00OTk4LTliZWItZTRiMzljZTVhMzM0OjExNWY1MjRmLWQ3YmEtNGI0Ni1hMTYxLWE4MmE5NmFkMjhkYg==
Utilizando na requisição
Para autenticação é necessário inserir a Header Authorization com o valor base64 calculado.
Header
Authorization: Basic ZGRlYTkzNTUtMWNiOS00OTk4LTliZWItZTRiMzljZTVhMzM0OjExNWY1MjRmLWQ3YmEtNGI0Ni1hMTYxLWE4MmE5NmFkMjhkYg==
Modificado em 2026-06-22 10:09:42
Próxima página
Recebendo um token de acesso
Built with