Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
0e53cfa
Update README.md
Angello-droid Oct 23, 2025
495db60
Update Banks.md
Angello-droid Oct 24, 2025
e6cdf50
Update Beneficiary.md
Angello-droid Oct 24, 2025
6ccf48e
Update Beneficiary.md
Angello-droid Oct 24, 2025
c72d323
Update Banks.md
Angello-droid Oct 24, 2025
dcdf7a0
Update Bills.md
Angello-droid Oct 24, 2025
de80cba
Update CardIssuing.md
Angello-droid Oct 24, 2025
9e9bd07
Update Collections.md
Angello-droid Oct 24, 2025
463348f
Update Misc.md
Angello-droid Oct 24, 2025
2d54bdb
Update OTP.md
Angello-droid Oct 24, 2025
bd29b9a
Update PaymentPlans.md
Angello-droid Oct 24, 2025
d3f0145
Update Settlements.md
Angello-droid Oct 24, 2025
9d7a55c
Update SubAccounts.md
Angello-droid Oct 24, 2025
bb4c2b2
Update Subscriptions.md
Angello-droid Oct 24, 2025
ebe0474
Update Tokenization.md
Angello-droid Oct 24, 2025
c538277
Update Transactions.md
Angello-droid Oct 24, 2025
56ab24e
Update Transfers.md
Angello-droid Oct 24, 2025
eb12d58
Update Transfers.md
Angello-droid Oct 24, 2025
cdcb1d5
Update VirtualAccount.md
Angello-droid Oct 24, 2025
0fea648
Update Collections.md
Angello-droid Oct 24, 2025
2b20d41
Update Collections.md
Angello-droid Oct 24, 2025
7e2b30a
Update Banks.md
Angello-droid Oct 24, 2025
81a4ba0
Update Beneficiary.md
Angello-droid Oct 24, 2025
39c17b9
Update Bills.md
Angello-droid Oct 24, 2025
dbab89d
Update CardIssuing.md
Angello-droid Oct 24, 2025
32063a9
Update Collections.md
Angello-droid Oct 24, 2025
e77a288
Update Misc.md
Angello-droid Oct 24, 2025
a69e0a5
Update OTP.md
Angello-droid Oct 24, 2025
f1e5707
Update PaymentPlans.md
Angello-droid Oct 24, 2025
6483650
Update ScheduledPayments.md
Angello-droid Oct 24, 2025
355fa4f
Update Settlements.md
Angello-droid Oct 24, 2025
a90c09d
Update SubAccounts.md
Angello-droid Oct 24, 2025
5a2fb50
Update Subscriptions.md
Angello-droid Oct 24, 2025
ee45db2
Update Tokenization.md
Angello-droid Oct 24, 2025
8300fe7
Update Transactions.md
Angello-droid Oct 24, 2025
8c118f0
Update Transfers.md
Angello-droid Oct 24, 2025
c1d90e7
Update VirtualAccount.md
Angello-droid Oct 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@

## Introduction

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.
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, enabling you to make quick calls to the APIs.

Available features include:

- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR.
- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, and NQR.
- Payouts and Beneficiaries.
- Recurring payments: Tokenization and Subscriptions.
- Split payments
- Card issuing
- Split payments.
- Card issuing.
- Transactions dispute management: Refunds and Chargebacks.
- Transaction reporting: Collections, Payouts, Settlements, Refunds and Chargebacks.
- Transaction reporting: Collections, Payouts, Settlements, Refunds, and Chargebacks.
- Bill payments: Airtime, Data bundle, Cable, Power, Toll, E-bills, and Remitta.
- Identity verification: Resolve bank account, resolve BVN information and generate OTP.
- Identity verification: Resolve bank account, resolve BVN information, and generate OTP.

# Heads Up!
This Library cannot be used on a project with a file named "base.properties" in project path.
This Library cannot be used on a project with a file named "base.properties" in the project path.


## Table of Content
## Table of Contents

1. [Requirements](#requirements)
2. [Installation](#installation)
Expand All @@ -42,8 +42,8 @@ This Library cannot be used on a project with a file named "base.properties" in

## Requirements

1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication)
2. Java
1. Flutterwave for business [API Keys](https://developer.flutterwave.com/v3.0.0/docs/authentication).
2. Java.


## Installation
Expand All @@ -68,16 +68,16 @@ compile("com.flutterwave:f4b-java:3.0")


## Environment Variables
The foloowing environment variables need to be set before calling any method
The following environment variables need to be set before calling any method:

```java
Environment.setSecretKey("FLWSECK_TEST-92e*******-X");
Environment.setPublicKey("FLWSECK_TEST-92e*******-X");
Environment.setEncryptionKey("FLWSECK_TE********c1f2");
```

For staging, Use TEST API Keys and for production, use LIVE API KEYS.
You can get your keys from the Flutterwave dashboard.
For staging, use your TEST API Keys, and for production, use your LIVE API Keys.
You can get your keys from the [Flutterwave dashboard](https://app.flutterwave.com/login).

Read the [requirement section](#requirements) for more information on how to get your API keys.

Expand All @@ -102,14 +102,14 @@ Read the [requirement section](#requirements) for more information on how to get

## Debugging Errors

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).
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/v3.0.0/docs/common-errors).

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.


## Support

For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg).
For additional assistance using this library, contact the Developer Experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg).

You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.

Expand Down
8 changes: 4 additions & 4 deletions documentation/Banks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

# BANKS

We recommend reading the main readme first, to understand the requirements for using the library and how to initiate this in your apps. This guide assumes you've read that.
We recommend reading the [main README](../README.md) first to understand the requirements for using the library and how to integrate it into your application. This guide assumes you've read that.

### Get all banks

This describes how to get list of banks you can transfer to
This describes how to get a list of banks you can transfer to.

```java

Expand All @@ -18,8 +18,8 @@ Response flwResponse = new Banks()

### Get bank branches

This describes how to get a list of bank branches
This describes how to get a list of bank branches.
```java
Response flwResponse = new Banks()
.getBankBranches(id)
```
```
12 changes: 6 additions & 6 deletions documentation/Beneficiary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

# BENEFICIARIES

We recommend reading the main readme first, to understand the requirements for using the library and how to initiate this in your apps. This guide assumes you've read that.
We recommend reading the [main README](../README.md) first to understand the requirements for using the library and how to integrate it into your application. This guide assumes you've read that.



## Create a beneficiary

This describes how to create a transfer beneficiary
This describes how to create a transfer beneficiary.
```java
Response flwResponse = new Beneficiaries()
.runCreateBeneficiary(new BeneficiaryRequest("0690000034",
Expand All @@ -22,24 +22,24 @@ Response flwResponse = new Beneficiaries()

## List all Transfer Beneficiaries

This describes how to list all transfer beneficiaries
This describes how to list all transfer beneficiaries.
```java
ListResponse flwResponse = new Beneficiaries()
.runGetAllBeneficiaries(Optional.page);
```

## Fetch a Transfer Beneficiary

This describes how to fetch a transfer beneficiary
This describes how to fetch a transfer beneficiary.
```java
Response flwResponse = new Beneficiaries()
.runGetBeneficiary(Optional.id);
```

## Delete a Transfer Beneficiary

This describes how to delete a transfer beneficiary
This describes how to delete a transfer beneficiary.
```java
Response flwResponse = new Beneficiaries()
.runDeleteBeneficiary(Optional.id);
```
```
18 changes: 9 additions & 9 deletions documentation/Bills.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

# Bills

We recommend reading the main readme first, to understand the requirements for using the library and how to initiate this in your apps. This guide assumes you've read that.
We recommend reading the [main README](../README.md) first to understand the requirements for using the library and how to integrate it into your application. This guide assumes you've read that.


## Get Bill Categories

This describes how to get bill categories
This describes how to get bill categories.

```java
new Bills().getCategories(Optional.airtime,
Expand All @@ -23,7 +23,7 @@ new Bills().getCategories(Optional.airtime,

## Create a bill payment

This describes how to create a bill payment
This describes how to create a bill payment.

```java
Response response = new Bills()
Expand All @@ -36,7 +36,7 @@ Response response = new Bills()

## Validate a bill service

This describes how to validate a bill service
This describes how to validate a bill service.

```java
Response response = new Bills().validateBillService("AT099",
Expand All @@ -45,7 +45,7 @@ Response response = new Bills().validateBillService("AT099",

## Create bulk bills

This describes how to create bulk bills
This describes how to create bulk bills.

```java
List<BillRequest> billRequestList = new ArrayList<>();
Expand All @@ -57,17 +57,17 @@ Response response = new Bills()

## Get bill payments

This describes how to get bill payments
This describes how to get bill payments.

```java
Response response = new Bills()
.getBills(from, to);
```

## Get actions of a bill payment
## Get actions of a bill payment.

This describes how to get actions of a bill payment
This describes how to get the status of a bill payment.

```java
Response response = new Bills().getStatus(id);
```
```
20 changes: 10 additions & 10 deletions documentation/CardIssuing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

# Card Issuing

We recommend reading the main readme first, to understand the requirements for using the library and how to initiate this in your apps. This guide assumes you've read that.
We recommend reading the [main README](../README.md) first to understand the requirements for using the library and how to integrate it into your application. This guide assumes you've read that.


## VIRTUAL CARDS

## Create virtual card

This describes how to create a new virtual card
This describes how to create a new virtual card.

```java
Response flwResponse = new VirtualCard()
Expand All @@ -36,7 +36,7 @@ Response flwResponse = new VirtualCard()

## Get All Virtual Cards

This describes how to get all virtual cards
This describes how to get all virtual cards.

```java
ListResponse flwResponse = new VirtualCard()
Expand All @@ -45,7 +45,7 @@ ListResponse flwResponse = new VirtualCard()

## Get A Virtual Card

This describes how to get a virtual cards
This describes how to get a virtual card.

```java
Response flwResponse = new VirtualCard()
Expand All @@ -54,7 +54,7 @@ Response flwResponse = new VirtualCard()

## Fund A Virtual Card

This describes how to fund a virtual cards
This describes how to fund a virtual card.

```java
Response flwResponse = new VirtualCard()
Expand All @@ -68,7 +68,7 @@ Response flwResponse = new VirtualCard()

## Withdraw From A Virtual Card

This describes how to wihdraw from a virtual card
This describes how to withdraw from a virtual card.

```java
ListResponse flwResponse = new VirtualCard()
Expand All @@ -77,7 +77,7 @@ ListResponse flwResponse = new VirtualCard()

## Block/Unblock Virtual Card

This describes how to block/unblock a virtual card
This describes how to block/unblock a virtual card.

```java
Response flwResponse = new VirtualCard()
Expand All @@ -86,7 +86,7 @@ Response flwResponse = new VirtualCard()

## Terminate A Virtual Card

This describes how to terminate a virtual card
This describes how to terminate a virtual card.

```java
Response flwResponse = new VirtualCard()
Expand All @@ -95,9 +95,9 @@ Response flwResponse = new VirtualCard()

## Get A Virtual Card's Transactions

This describes how to get a virtual cards' transaction
This describes how to get a virtual card's transaction.

```java
ListResponse flwResponse = new VirtualCard()
.runTerminateVirtualCard("");
```
```
Loading
Loading