1. Autenticação
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
  1. Autenticação

Recebendo um token de acesso

POST
/auth
Request body:
{
  "username":"your-username",
  "password":"your-password"
}
Objeto de response
elementtypedescription
tokenstringToken de autenticação
typestringTipo de autenticação
expires_inDateTimeTempo de expiração do token
Response body:
{
  "token":"string token",
  "type":"Bearer",
  "expires_in":yyyy-MM-ddThh:mm:ss
}

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 '/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-06-22 10:09:42
Página anterior
Autenticação
Próxima página
Dados da conta
Built with