Easy-to-use interface for integrating Flutter apps with Sicoob's Pix API

by Flutter Awesome

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.

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 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

GetToken

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

Features

  • PIX:
    • ✅ Fetch received PIX transactions
    • 🚧 Fetch specific pix transaction
    • 🚧 Request return
    • 🚧 Consult return
    )

    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

    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.

    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.

    GitHub

    View Github