Valut Global

Authentication

Retrieve access token

Account

Current balance of account

Retrieving account balance

Listing account transactions

Whitelabel API

Listing customers

Pix - Cashout

Retrieving pix cashout data

Performing pix cashout

Listing pix cashout data

Pix - Cashin

Creating pix cashin qrcode

Listing qrcodes pix

Retrieving qrcode data

Refunding pix

Inativando um qrcode

Transfers

Consulting branch account by document

Transfer using p2p

Transfer using ted

Boletos

Listing boletos

Creating a boleto

Cancel boleto

Payment

Consulting payment by barcode

Barcode payment

Webhook

Creating webhooks

Listing webhooks

Delete webhook

Blank

Openbanking API

Production

Sandbox

The Authentication section of the OpenBanking API allows you to handle user authentication and access control for your application. It provides the necessary features to securely authenticate users and manage their access to sensitive banking data.By utilizing this endpoint, you can ensure that only authorized users can access the banking data and perform actions on behalf of the user. It offers a seamless and secure way to verify the identity of users and protect their sensitive information.To make integration even easier, the API documentation provides comprehensive examples and code snippets that demonstrate how to implement the authentication flow in various programming languages. Non-technical roles can also benefit from the clear explanations and step-by-step guides included in the documentation.Please note that the Authentication endpoint requires proper configuration and adherence to security best practices to ensure the protection of user information. Make sure to follow the recommended guidelines and regularly update your authentication mechanisms to stay ahead of potential security threats.Overall, the Authentication section of the OpenBanking API simplifies the integration of user authentication and access control, allowing you to securely manage user access to sensitive banking data in your application.

The Authentication section of the OpenBanking API allows you to handle user authentication and access control for your application. It provides the necessary features to securely authenticate users and manage their access to sensitive banking data.

By utilizing this endpoint, you can ensure that only authorized users can access the banking data and perform actions on behalf of the user. It offers a seamless and secure way to verify the identity of users and protect their sensitive information.

To make integration even easier, the API documentation provides comprehensive examples and code snippets that demonstrate how to implement the authentication flow in various programming languages. Non-technical roles can also benefit from the clear explanations and step-by-step guides included in the documentation.

Please note that the Authentication endpoint requires proper configuration and adherence to security best practices to ensure the protection of user information. Make sure to follow the recommended guidelines and regularly update your authentication mechanisms to stay ahead of potential security threats.

Overall, the Authentication section of the OpenBanking API simplifies the integration of user authentication and access control, allowing you to securely manage user access to sensitive banking data in your application.

The Account API section provides access to information about user accounts. With this API, you can retrieve detailed data about a user&apos;s accounts, including their balance, transaction history, and account details. This information can be accessed using a GET request to the specified API endpoint. The Account API is designed to make it easy for developers to integrate banking functionality into their applications, providing a seamless experience for users. It also offers special features such as the ability to filter and sort account data based on specific criteria, allowing for more targeted retrieval of information. Whether you&apos;re building a personal finance app, a budgeting tool, or a banking platform, the Account API provides the necessary functionality to retrieve and display account information in a clear and structured manner.

The OpenBanking API&apos;s GET section provides access to the Whitelabel API endpoint. This endpoint allows you to retrieve specific data from the OpenBanking platform. By making a GET request to this endpoint, you can retrieve information related to whitelabeling options and settings. This includes details such as custom branding, user interface customization, and other whitelabeling features. With the Whitelabel API, you can easily integrate these whitelabeling capabilities into your own applications. Whether you are a developer looking to incorporate advanced branding options into your app or a non-technical role responsible for managing the platform&apos;s whitelabeling settings, this API section provides the necessary functionality to simplify the integration process.

The Pix - Cashout API endpoint allows you to initiate a cashout transaction using the OpenBanking API. This API enables you to transfer funds from a customer&apos;s account to another account securely. It supports cashout requests for various purposes, such as withdrawing funds, making payments, or transferring money between accounts.To use this API, you need to provide the necessary information, including the customer&apos;s account details, the amount to be cashed out, and the recipient&apos;s account information. The API will validate the provided data and process the cashout transaction accordingly.This API endpoint provides a convenient way to facilitate cashout transactions, simplifying the process for both developers and non-technical users. It ensures the secure transfer of funds while ensuring compliance with OpenBanking standards.If you encounter any issues or have specific requirements for the cashout transaction, please refer to the relevant sections of the documentation for additional details and considerations.

The Pix - Cashin API endpoint is used to facilitate cash-in transactions using the OpenBanking API. This functionality enables users to transfer funds from their bank accounts to their Pix digital wallets. This API section provides a straightforward and secure way to integrate cash-in functionality into your application or platform. It supports seamless communication between your application and bank accounts, allowing users to conveniently top up their Pix wallets with ease. It is important to note that this API endpoint requires proper authentication and authorization to ensure the security of transactions. By integrating this API, you can empower your users to easily manage and utilize their funds within your application or platform.

The Transfers API section allows you to retrieve information about transfers made through the OpenBanking API. This API endpoint gives you access to details such as the transfer amount, currency, sender and recipient information, and any associated metadata. By utilizing this API, you can easily retrieve transfer information for various use-cases, such as monitoring transaction history, reconciling financial records, or building transfer-related features within your application. Additionally, this API section includes special considerations for handling pagination, filtering, and sorting of transfer data to optimize your integration. With the Transfers API, you can seamlessly retrieve and manage transfer information to enhance your application&apos;s functionality.

Consulting Account Data

This header parameter is used to authenticate the request. It should contain a valid access token or API key for the authorized user.

Authorization

The type of document used to identify the consulting branch account.

document

The unique identifier for the consulting branch account.

account_id

The name associated with the consulting branch account.

name

The tax identification number associated with the consulting branch account.

tax_id

The email address associated with the consulting branch account.

email

The date and time when the consulting branch account was created.

created_at

A message containing additional information about the transfer.

message

An additional parameter name for the consulting branch account.

parameterName

Transfer using p2pThis API endpoint allows you to transfer funds between two accounts using person-to-person (p2p) payment. With this functionality, you can easily send money from one account to another securely and efficiently.The p2p transfer feature is designed to simplify fund transfers, making it ideal for a wide range of use-cases. Whether you need to pay a friend back for dinner, split bills with roommates, or transfer funds between your own accounts, this API provides a seamless solution.One of the key benefits of this endpoint is its simplicity. By utilizing straightforward parameters and a user-friendly interface, integrating this API into your application is a breeze. Both developers and non-technical roles can easily understand and implement this transfer functionality without any hassle.To ensure the utmost security, all p2p transfers are encrypted and authenticated, guaranteeing the protection of sensitive financial data. Additionally, this API section includes comprehensive error handling, providing clear and actionable error messages in case of any issues during the transfer process.Whether you are building a banking application, a payment platform, or any other financial service, the p2p transfer API endpoint offers a reliable and efficient method to facilitate fund transfers between accounts. Start integrating this functionality into your application today and enhance the user experience by enabling seamless money transfers.

This API endpoint allows you to transfer funds between two accounts using person-to-person (p2p) payment. With this functionality, you can easily send money from one account to another securely and efficiently.

The p2p transfer feature is designed to simplify fund transfers, making it ideal for a wide range of use-cases. Whether you need to pay a friend back for dinner, split bills with roommates, or transfer funds between your own accounts, this API provides a seamless solution.

One of the key benefits of this endpoint is its simplicity. By utilizing straightforward parameters and a user-friendly interface, integrating this API into your application is a breeze. Both developers and non-technical roles can easily understand and implement this transfer functionality without any hassle.

To ensure the utmost security, all p2p transfers are encrypted and authenticated, guaranteeing the protection of sensitive financial data. Additionally, this API section includes comprehensive error handling, providing clear and actionable error messages in case of any issues during the transfer process.

Whether you are building a banking application, a payment platform, or any other financial service, the p2p transfer API endpoint offers a reliable and efficient method to facilitate fund transfers between accounts. Start integrating this functionality into your application today and enhance the user experience by enabling seamless money transfers.

Transaction amount. Amount in cents.

Ex.: R$ 10,50 = 1050 cents

amount

A brief description or summary of the transaction. This can be used to provide additional information or clarify the purpose of the transaction.

description

Valut Global or Internal Account Id. This id is received in GET v1/transfer

destination_account_id

The monetary value of the transaction. This includes both the currency and the specific amount being transferred.

The date and time when the transaction took place. This is in a standardized format to ensure consistency across different systems and time zones.

date

The type of transaction being performed, such as a transfer, payment, or purchase.

type

The unique identifier for the transaction. This can be used for tracking and referencing the transaction.

transactionId

Additional details or information related to the transaction. This can include any specific instructions, terms, or conditions associated with the transaction.

details

Transfer using ted:The OpenBanking API provides a simple and secure way to transfer funds using the ted method. This method allows you to initiate a transfer between two bank accounts.With the ted method, you can specify the source account, destination account, and the amount to be transferred. The API will validate the accounts and ensure that the funds are available before initiating the transfer.This method is particularly useful for making one-time transfers, such as paying bills or sending money to friends or family. It provides a convenient and efficient way to manage your finances and perform transactions.Please note that when using the ted method, you need to ensure that you have the necessary permissions and access to the accounts involved in the transfer. Additionally, make sure to provide accurate and valid account information to avoid any issues during the transfer process.If you encounter any difficulties or have questions regarding the ted method or the OpenBanking API in general, please refer to the relevant sections in this documentation or reach out to our support team for assistance. We are here to help you integrate the API seamlessly and make your transfer experience as smooth as possible.

The OpenBanking API provides a simple and secure way to transfer funds using the ted method. This method allows you to initiate a transfer between two bank accounts.

With the ted method, you can specify the source account, destination account, and the amount to be transferred. The API will validate the accounts and ensure that the funds are available before initiating the transfer.

This method is particularly useful for making one-time transfers, such as paying bills or sending money to friends or family. It provides a convenient and efficient way to manage your finances and perform transactions.

Please note that when using the ted method, you need to ensure that you have the necessary permissions and access to the accounts involved in the transfer. Additionally, make sure to provide accurate and valid account information to avoid any issues during the transfer process.

If you encounter any difficulties or have questions regarding the ted method or the OpenBanking API in general, please refer to the relevant sections in this documentation or reach out to our support team for assistance. We are here to help you integrate the API seamlessly and make your transfer experience as smooth as possible.

A text description or additional information related to the transaction.

TED destination object, contains the data to perform the transaction.

ted_destination

The date and time when the transaction was processed.

The type of transfer performed, such as a fund transfer or payment.

The unique identifier for the transaction.

Additional details or metadata associated with the transaction.

The Boletos API section provides functionality to retrieve information about boletos (Brazilian payment slips) in the OpenBanking API. This API endpoint allows you to access various details related to boletos, such as their status, due date, payment amount, and barcode information.The Boletos API is designed to make it easy for developers to integrate boletos functionality into their applications. Whether you are building a financial management application or a payment processing system, this API endpoint enables you to fetch boleto details efficiently.In addition to standard boleto information, the Boletos API also provides support for special features and considerations. These include the capability to filter boletos based on their payment status, retrieve boletos within a specific date range, and fetch boletos associated with a particular customer or transaction. These features allow you to tailor the API calls to suit your specific integration requirements.

The Boletos API is designed to make it easy for developers to integrate boletos functionality into their applications. Whether you are building a financial management application or a payment processing system, this API endpoint enables you to fetch boleto details efficiently.

In addition to standard boleto information, the Boletos API also provides support for special features and considerations. These include the capability to filter boletos based on their payment status, retrieve boletos within a specific date range, and fetch boletos associated with a particular customer or transaction. These features allow you to tailor the API calls to suit your specific integration requirements.

 é necessário solicitar a requisição POST para a rota 

, nesse passo você deve configurar a URL para 

, o tipo de evento e a autorização, caso haja.

Este evento ocorre quando um pagamento de PIX via Chave ou QRCode é realizado pela plataforma. Abaixo segue o corpo da requisição enviado para a rota de callback configurada pelo Webhook.

string

Este evento ocorre quando um recebimento de QRCode PIX via é realizado. Abaixo segue o corpo da requisição enviado para a rota de callback configurada pelo Webhook.

Obs.: Transação de DEVOLUÇÃO PIX é considerada recebimento e aciona este 

Title

Description

Este evento ocorre quando ocorre o recebimento de um BOLETO. Abaixo segue o corpo da requisição enviado para a rota de callback configurada pelo Webhook.

Sections