Skip to main content

Bank Account - BRL

Introduction​

The Bank Account - BRL establishes a connection between the traditional Brazilian Real (BRL) payment system and blockchain systems, acting as a bridge for seamless transactions.

This section will guide you through providing visibility of the Bank Account - BRL within Avenia API for efficient and secure integrations.

Bank Account - BRL Initialization​

The initialization of your Bank Account - BRL is performed during the creation of your Business Account (BA). Upon creating your Business Account, a fiat rail is automatically initialized along with Avenia wallets by default. You will have visibility of these details in the following sections.

Get Bank Account - BRL Information​

Since Bank Account - BRL was initialized during the creation of your business account, we will now retrieve this information.

HTTP GET Request​

https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/brl/

cURL Example:​

curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/brl/" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

JSON Response​

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "ACTIVE",
  "bankName": "starkbank",
  "pixKey": "11111111-1111-1111-1111-111111111111",
  "ispb": "00000000",
  "bankCode": "000",
  "branchCode": "0000",
  "accountNumber": "0000000000000000",
  "accountType": "payment",
  "createdAt": "2025-03-10T15:23:17.801357Z"
}

Get Pix Info​

The Pix Info endpoint provides information about the owner of a Pix key and their associated bank. It supports both Pix keys (e.g., CPF, email, phone number) and BR Codes.

Parameters​

FieldTypeDescription
pixKeystringHere a BrCode or Pix Key that you would like to know more about
decodePixKeyboolIf the pixKey field is a pixKey, and you want to collect more information from this pixKey, pass this field as true

HTTP GET Request​

https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/brl/pix-info

cURL Example:

curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/brl/pix-info?pixKey=00000000000&decodePixKey=true" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

JSON Response​

{
  "name": "Herminia Kloth",
  "taxId": "***.317.608-**",
  "bankName": "Herminia Kloth",
  "amount": ""
}

Conclusion​

In this section, you have learned how to interact with the Bank Account - BRL within Avenia API:

  • ✅ Retrieving Bank Account - BRL Information – Obtaining initialized bank account details.
  • ✅ Getting Pix Info – Retrieving detailed information related to a Pix key or BR Code.

You now have the necessary understanding to handle BRL fiat rails effectively.