pix_bb 0.1.3

Easy-to-use interface for integrating with Banco do Brasil's Pix API.

Pix BB - Easy to use interface for integrating with Banco do Brasil's Pix API in your Flutter Apps.

This package offers an easy-to-use interface for integrating with Banco do Brasil's Pix API. With this package, you can get transaction information quickly and efficiently in your Flutter apps.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. How To Use
3. Features
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

This package offers an easy-to-use interface for integrating with Banco do Brasil's Pix API. With this package, you can get transaction information quickly and efficiently in your Flutter apps.

(back to top)

Getting Started

To install This package in your project you can follow the instructions below:

a) Add in your pubspec.yaml:

 dependencies:
    pix_bb: <last-version>

b) or use:

 dart pub add pix_bb

(back to top)

How To Use

This package is ready for get transactions information quickly!

final pixBB = PixBB();


// Make a request to the API with request a list of transactions received from the last 4 days


await pixBB.getToken(basicKey: basicKey).then(
(token) => pixBB.getRecentReceivedTransactions(
  accessToken: token.accessToken,
  developerApplicationKey: developerApplicationKey,
),
).then((response) {
  print(response); // it's a List<Pix>.
}).catchError((error) {
  print(error); // It's a PixError.
});



// Request a list of transactions as of a specific date

//Attention!, the maximum difference in days between the start and end date must be 4 days    


await pixBB.getToken(basicKey: basicKey).then(
(token) => pixBB.getTransactionsByDate(
  accessToken: token.accessToken,
  developerApplicationKey: developerApplicationKey,
  initialDate: DateTime.now().subtract(const Duration(days: 6)),
  finalDate: DateTime.now(),
),
).then((response) {
  print(response); // it's a List<Pix>.
}).catchError((error) {
  print(error); // It's a PixError.
});

For more examples, please refer to the Documentation

(back to top)

Features

• ✅ GET RECENT TRANSCATIONS
• ✅ GET TRANSACTIONS BY DATE

Right now this package has concluded all his intended features. If you have any suggestions or find something to report, see below how to contribute to it.

(back to top)

---

Use cases

Request an access token

Request a list of transactions received from the last 4 days

accessToken = await bb.getToken(basicKey: 'BASIC_KEY');

Get recent trasactions

Request a list of transactions received from the last 4 days

await getRecentReceivedTransactions(
        accessToken: accessToken,
        developerApplicationKey: 'DEV_APP_KEY',
      );

Get transactions by date

Request a list of transactions as of a specific date

Attention!, the maximum difference in days between the start and end date must be 4 days

await getTransactionsByDate(
        initialDate: DateTime.now().subtract(const Duration(days: 4)),
        finalDate: DateTime.now(),
        accessToken: accessToken,
        developerApplicationKey: 'DEV_APP_KEY',
      );

Contributing

🚧 Contributing Guidelines - Currently being updated 🚧

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the appropriate tag. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Remember to include a tag, and to follow Conventional Commits and Semantic Versioning when uploading your commit and/or creating the issue.

(back to top)

License

Distributed under the MIT LICENSE.txt for more information.

(back to top)

Aknowledgements

Thank you to all the people who contributed to this project, whithout you this project would not be here today.

(back to top)

Maintaned by

---

Built and maintained by AcxTech Sistemas.