|
2 | 2 | <img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo/full.svg" width="50%"/> |
3 | 3 | </p> |
4 | 4 |
|
5 | | -# Flutterwave Java |
6 | | -This is the official Java library for our v3 payment APIs. |
| 5 | +# Flutterwave v3 Java Library |
| 6 | +//Add shields |
| 7 | + |
| 8 | +## Introduction |
| 9 | + |
| 10 | +The Java library provides easy access to Flutterwave for Business (F4B) v3 APIs for your Java codebase. It abstracts the complexity involved in direct integration and allows you to make quick calls to the APIs. |
| 11 | + |
| 12 | +Available features include: |
| 13 | + |
| 14 | +- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR. |
| 15 | +- Payouts and Beneficiaries. |
| 16 | +- Recurring payments: Tokenization and Subscriptions. |
| 17 | +- Split payments |
| 18 | +- Card issuing |
| 19 | +- Transactions dispute management: Refunds and Chargebacks. |
| 20 | +- Transaction reporting: Collections, Payouts, Settlements, Refunds and Chargebacks. |
| 21 | +- Bill payments: Airtime, Data bundle, Cable, Power, Toll, E-bills, and Remitta. |
| 22 | +- Identity verification: Resolve bank account, resolve BVN information and generate OTP. |
| 23 | + |
| 24 | + |
| 25 | +## Table of Content |
| 26 | + |
| 27 | +1. [Requirements](#requirements) |
| 28 | +2. [Installation](#installation) |
| 29 | +3. [Initialization](#initialization) |
| 30 | +4. [Usage](#usage) |
| 31 | +5. [Testing](#testing) |
| 32 | +6. [Debugging Errors](#debugging-errors) |
| 33 | +7. [Support](#support) |
| 34 | +8. [Contribution guidelines](#contribution-guidelines) |
| 35 | +9. [License](#license) |
| 36 | +10. Changelog |
| 37 | + |
| 38 | +## Requirements |
| 39 | + |
| 40 | +1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication) |
| 41 | +2. Java |
| 42 | + |
| 43 | + |
| 44 | +## Installation |
| 45 | +To install the library, |
| 46 | + |
| 47 | + |
| 48 | +## Environment Variables |
| 49 | +The foloowing environment variables need to be set before calling any method |
| 50 | + |
| 51 | +```java |
| 52 | + Environment.setSecretKey("FLWSECK_TEST-92e*******-X"); |
| 53 | + Environment.setPublicKey("FLWSECK_TEST-92e*******-X"); |
| 54 | + Environment.setEncryptionKey("FLWSECK_TE********c1f2"); |
| 55 | +``` |
| 56 | + |
| 57 | +For staging, Use TEST API Keys and for production, use LIVE API KEYS. |
| 58 | +You can get your keys from the Flutterwave dashboard. |
| 59 | + |
| 60 | +Read the [requirement section](#requirements) for more information on how to get your API keys. |
| 61 | + |
| 62 | +## Usage |
| 63 | +1. [Collections](documentation/Collections.md) |
| 64 | +2. [Tokenization](documentation/Tokenization.md) |
| 65 | +3. [Split payments](documentation/SplitPayments.md) |
| 66 | +4. [Scheduled payments](documentation/ScheduledPayments.md) |
| 67 | +5. [Transfers](documentation/Transfers.md) |
| 68 | +6. [Card Issuing](documentation/CardIssuing.md) |
| 69 | +7. [Virtual Account](documentation/VirtualAccount.md) |
| 70 | +8. [Bill payments](documentation/Bills.md) |
| 71 | +9. [Transactions and reporting](documentation/Transactions.md) |
| 72 | +10. [Beneficiaries](documentation/Beneficiary.md) |
| 73 | +11. [Banks](documentation/Banks.md) |
| 74 | +12. [Settlements](documentation/Settlements.md) |
| 75 | +13. [OTP](documentation/OTP.md) |
| 76 | +13. [Ebills](documentation/Ebills.md) |
| 77 | +14. [Misc](documentation/Misc.md) |
| 78 | + |
| 79 | + |
| 80 | +## Debugging Errors |
| 81 | + |
| 82 | +We understand that you may run into some errors while integrating our library. You can read more about our error messages [here](https://developer.flutterwave.com/docs/integration-guides/errors). |
| 83 | + |
| 84 | +For `authorization` and `validation` error responses, double-check your API keys and request. If you get a `server` error, kindly engage the team for support. |
| 85 | + |
| 86 | + |
| 87 | +## Support |
| 88 | + |
| 89 | +For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:developers@flutterwavego.com) or on [slack](https://bit.ly/34Vkzcg). |
| 90 | + |
| 91 | +You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊. |
| 92 | + |
| 93 | + |
| 94 | +## Contribution guidelines |
| 95 | +Read more about our community contribution guidelines [here](/CONTRIBUTING.md) |
| 96 | + |
| 97 | + |
| 98 | +## License |
| 99 | + |
| 100 | +By contributing to this library, you agree that your contributions will be licensed under its [MIT license](/LICENSE). |
| 101 | + |
| 102 | +Copyright (c) Flutterwave Inc. |
0 commit comments