Pix Sicoob – Easy to use interface for integrating with Sicoob Pix API in your Flutter Apps.
This package offers an easy-to-use interface for integrating with Sicoob Pix API. With this package, you can get transaction information quickly and efficiently in your Flutter apps.
Table of Contents
About The Project
This package offers an easy-to-use interface for integrating with Sicoob’s Pix API. With this package, you can get transaction information quickly and efficiently in your Flutter apps.
- Key Pix registered with Sicoob
- Exclusive for legal entities
- Valid certificate issued by an external CAs complying with the international standard x.509
- Registration on the Sicoob Developers Portal
To install This package in your project you can follow the instructions below:
a) Add in your pubspec.yaml:
dependencies: pix_sicoob: <last-version>
b) or use:
dart pub add pix_sicoob
How To Use
This package is ready for get transactions information quickly!
First instantiate the class passing the appropriate parameters
final pixSicoob = PixSicoob( clientID:'CLIENT_ID', certificateBase64String: 'X509_Parsed_TO_BASE64_STRING', /* This package offer a method to parses file certificate to base64 String Method: final certBase64String = pixSicoob.certFileToBase64String( pkcs12CertificateFile: File('test/cert/cert.pfx'), ); */ certificatePassword: 'CERTIFICATE_PASSWORD', );
For more examples, please refer to the Documentation
- ✅ Fetch received PIX transactions
- 🚧 Fetch specific pix transaction
- 🚧 Request return
- 🚧 Consult return
- Default Time Range
- Custom Time Range
Convert certificate file to Base64String
final certBase64String = pixSicoob.certFileToBase64String( pkcs12CertificateFile: File('test/cert/cert.pfx'));
Request a token
final token = await pixSicoob.getToken();
Fetch Pix Transactions
final listPix = await pixSicoob.fetchTransactions( token: token, ); //Returns the last 4 days transactions
final listPix = await pixSicoob.fetchTransactions( token: token, dateTimeRange: DateTimeRange( start: DateTime.now().subtract(Duration(days: 360)), end: DateTime.now(), ); ); //Returns the transactions of the specified date range
🚧 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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature)
- Commit your Changes (
git commit -m 'Add some AmazingFeature')
- Push to the Branch (
git push origin feature/AmazingFeature)
- Open a Pull Request
Distributed under the MIT
LICENSE.txt for more information.
Check the architecture used in the project
Thank you to all the people who contributed to this project, whithout you this project would not be here today.
Built and maintained by AcxTech Sistemas.