HomeSiteDashboardInternet Bank
HomeSiteDashboardInternet Bank
  1. Autenticação
  • Core
    • oAuth
      • oauth2/token
      • oauth2/refresh_token
      • account/forgot_password
      • account/change_password
    • account
      • notifications
        • account/notifications
        • account/notifications/config
        • account/notifications/config
        • account/notifications/{id}/read
      • account/me
      • account/balance
      • account/balances
      • account/statement
      • account/last_statement
      • account/products
      • account/send_phone_code
      • account/register (cpf)
      • account/register (cnpj)
      • account/verifie_phone_code
      • account/upload_docs
      • account/transactional_password
      • account/check_document
      • account/profile_photo
      • account/rating
      • account/transactional_password
      • account/verifie_transactional_password
      • account/phone
      • account/phone/validate
      • account/password
      • account/tooltip
      • account/profile_photo
      • account/country
      • account/report
      • account/active
    • health
      • status
    • id
      • id/token
      • id/verifie_token
      • id/transactional_password
      • id/verifie_essential
    • version
      • version/app
    • Ultils
      • country
    • Representative
      • Add Lead
      • Add Lead Copy
      • root_account
    • validations
      • account/check_phone_number
      • account/check_email
      • account/search_postal_code
    • banking
      • institutions
      • /institutions/{id}
      • /institutions/{bankId}/branch/{code}
  • OpenBanking
    • Autenticação
      • Recebendo um token de acesso
        POST
    • Conta
      • Dados da conta
      • Visualizar saldo na conta
    • PIX
      • Pagamento
        • Iniciando e Confirmando o PIX
        • Listando Pagamentos de PIX
        • Detalhe de um Pagamento PIX
      • Recebimento
        • Criando QRCode PIX
        • Listando QRCodes
        • Detalhe de um QRCode
        • Devolvendo PIX Recebido
        • Encontrando pix pelo EndToEndId
        • Inativando um QRCode
    • Transferências
      • Consulta conta disponível transferências
      • Transferências entre contas P2P
      • Transferências entre contas P2P por Lote
      • Transferências entre contas TED
    • Boletos
      • Retornando lista de boleto emitidos
      • Emitindo um boleto
      • Cancelando um boleto
    • Pagamentos de Títulos
      • Consulta código de barras
      • Pagamento código de barras
    • Webhook
      • Criando um webhook
      • Listando webhooks
      • Removendo webhook
    • HealthCheck
      GET
  1. Autenticação

Recebendo um token de acesso

Production
https://api.valut.app/openbank/v1
Production
https://api.valut.app/openbank/v1
POST
https://api.valut.app/openbank/v1
/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
Authorization
string 
opcional
Exemplo:
Basic e3thcGkta2V5fX06e3thcGktc2VjcmV0fX0=
Parâmetros Bodyapplication/json
username
string 
requerido
password
string 
requerido
Exemplo
{
    "username":"25063974000145",
    "password":"3629da23c373483c"
}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.valut.app/openbank/v1/auth' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "username":"25063974000145",
    "password":"3629da23c373483c"
}'

Respostas

🟢200Recebendo um token de acesso
application/json
Body
expires_in
string 
requerido
token_type
string 
requerido
access_token
string 
requerido
Exemplo
{
    "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 2024-12-09 16:16:36
Página anterior
/institutions/{bankId}/branch/{code}
Próxima página
Dados da conta
Built with