pix_sicoob 1.1.3
pix_sicoob: ^1.1.3 copied to clipboard
Easy-to-use interface for integrating Flutter apps with Sicoob's Pix API.
Pix Sicoob - Easy to use interface for integrating with Sicoob Pix API in your Flutter Apps.
![Logo](https://raw.githubusercontent.com/AcxTechSistemas/pix_sicoob/main/images/package-logo.jpeg)
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.
Explore the docs »
Report Bug
·
Request Feature
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.
Pre Requirements #
- 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
Getting Started #
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
- Second get the token
- Third fetch your Pix transactions quickly!
Instantiate the class #
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',
);
Get the token #
final token = await pixSicoob.getToken();
Fetch your Pix transacations Quickly! #
final listPix = await pixSicoob.fetchTransactions(
token: token,
);
//Returns the last 4 days transactions
For more examples, please refer to the Documentation
Features #
- PIX:
- ✅ Fetch received PIX transactions
- 🚧 Fetch specific pix transaction
- 🚧 Request return
- 🚧 Consult return
-
COB:
- ✅ Create an immediate charge
- 🚧 Review Immediate Billing
- 🚧 Consult Immediate Billing
- 🚧 Get the qrcode image of an immediate charge
- 🚧 Consult list of immediate charges
-
COBV:
- 🚧 Create billing due
- 🚧 Review billing due
- 🚧 Consult Billing due
- 🚧 Get qrcode image of a due charge
- 🚧 Consult list of due charges
-
LOTECOBV:
- 🚧 Create / Change batch of due charges
- 🚧 Review specific charges within a batch of due charges
- 🚧 Consult a specific batch of due charges
- 🚧 Consult batches of charges due
- WEBHOOK:
- 🚧 Configure PIX webhook
- 🚧 Display information about the PIX webhook
- 🚧 Cancel PIX webhook
- 🚧 Consult registered webhooks
Use cases #
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 #
- Default Time Range
final listPix = await pixSicoob.fetchTransactions(
token: token,
);
//Returns the last 4 days transactions
- Custom Time Range
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
Handling errors #
- This package provides several ways to handle errors that may occur.
try {
// Code that may throw an exception
} on SicoobApiException catch (e) {
// Handle error response from Sicoob API
print('Sicoob API error: ${e.message}');
} on SicoobCertificateException catch (e) {
// Handle error with Pix certificate
print('Pix certificate error: ${e.message}');
} on SicoobHttpException catch (e) {
// Handle HTTP request error
print('HTTP request error: ${e.message}');
} on SicoobUnknownException catch (e) {
// Handle unknown error
print('Unknown error: ${e.message}');
} catch (e) {
// Handle other types of exceptions
print('Unexpected error: $e');
}
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!
- 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
Remember to include a tag, and to follow Conventional Commits and Semantic Versioning when uploading your commit and/or creating the issue.
License #
Distributed under the MIT LICENSE.txt
for more information.
Architecture #
Check the architecture used in the project ARCHITECTURE.md
Aknowledgements #
Thank you to all the people who contributed to this project, whithout you this project would not be here today.
Maintaned by #
Built and maintained by AcxTech Sistemas.