This repository is an unofficial golang wrapper for the BRLA APIs.
- Official API documentation for standard users can be found here.
- For users with superuser roles, the documentation is available here.
This library is designed with Clean Architecture principles to enhance maintainability, testability, and scalability.
Please refer to the LICENSE file for licensing details.
| Endpoint | Description | Status |
|---|---|---|
| 🔜 Coming soon! | Methods are not yet implemented. | ❌ |
| Endpoint | Description | Status |
|---|---|---|
| 🔑 Login | Authenticate using email and password. Returns a JWT token. | ✔️ |
| Password Reset | Request a password reset. | ❌ |
| Finish Password Reset | Finish the password reset process. | ❌ |
| Change account password | Change the account password. | ❌ |
| Logout | Invalidate the current JWT token. | ❌ |
| 💸 Buy Static Pix | Creates a ticket for minting BRLA. Duration can be configured, and extra fees can be paid using an BRLA Account balance if available | ✔️ |
| 💸 Sell | Create sell order with input information | ✔️ |
| Buy operations history | Retrieves paginated BRLA buy transactions for user | ❌ |
| Pix to USD history | Fetch Pix to USD conversion history | ❌ |
| Pix to USD | Creates a ticket for buying a dollar stablecoin. Requires a valid token obtained from the fast-quote endpoint | ✔️ |
| 💰 Get Balance Of | Retrieve blockchain balance | ✔️ |
| 📜 Get Contract Addresses | Fetch contract addresses | ✔️ |
| 🛡️ Get KYC Status | Check Know Your Customer status | ✔️ |
| 🔓 Get Public Key | Retrieve the public key | ✔️ |
| 📉 Get Used Limit | View the used transaction limit | ✔️ |
| 🧑⚖️ KYC Level One (Natural) | Basic KYC for natural persons | ✔️ |
| 🏢 KYC Level One (Legal) | Basic KYC for legal entities | ✔️ |
| 🧑⚖️ KYC Level Two (Natural) | Advanced KYC for natural persons | ✔️ |
| 🏢 KYC Level Two (Legal) | Advanced KYC for legal entities | ✔️ |
| 🔜 Coming soon! | More methods are not yet implemented. | ❌ |
Contributions and suggestions are welcome!
- Fork this repository.
- Open a pull request with your changes.
- I’ll review it as soon as possible.
TODO: Add linting guidelines.
Special thanks to ThalesSathler for inspiring this project and providing best practice examples.
And, of course, to the BRLA team, which is always available to help.