Brasil Cash Gateway
    main
    • main
    • v3
    • Autenticação
      • Recebendo um token de acesso
        POST
    • Conta
      • Dados da conta
        GET
      • Listar transactions
        GET
      • Visualizar saldo na conta
        GET
    • Transferências
      • Transferência Interna (P2P)
        POST
    • PIX
      • Cashin
        • Criando um QRCode PIX
        • Static QRCODE
        • Detalhe de um QRCode
        • Inativando um QRCode
      • Cashout
        • Overview
        • Iniciando PIX Chave
        • Lendo dados QRCode
        • Iniciando PIX QRCODE
        • Iniciando PIX Manual
        • Confirmando PIX
        • Listando Pagamentos de PIX
        • Detalhe de um Pagamento PIX
      • Dict
        • Listing Dict
        • Creating PIX KEY
        • Cancel PIX key
    • Esquemas
      • PIX
        • ReceiverPayer
        • Pix Initiate
        • Pix Consulta
        • Paginação
      • ApplicationError

    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