Skip to content

Commit 54e7c86

Browse files
cleopatra27cleopatra27
committed
updates
- Add query parameters - add more docs - add beneficiries
1 parent 9a46695 commit 54e7c86

83 files changed

Lines changed: 913 additions & 198 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.DS_Store‎

2 KB
Binary file not shown.

‎README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,9 @@ Read the [requirement section](#requirements) for more information on how to get
7373
11. [Banks](documentation/Banks.md)
7474
12. [Settlements](documentation/Settlements.md)
7575
13. [OTP](documentation/OTP.md)
76-
14. [Ebills](documentation/Ebills.md)
77-
15. [Misc](documentation/Misc.md)
78-
16. [Subscriptions](documentation/Subscriptions.md)
79-
17. [PaymentPlans](documentation/PaymentPlans.md)
76+
14. [Misc](documentation/Misc.md)
77+
15. [Subscriptions](documentation/Subscriptions.md)
78+
16. [PaymentPlans](documentation/PaymentPlans.md)
8079

8180

8281
## Debugging Errors

‎documentation/Beneficiary.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<p align="center">
2+
<img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo/full.svg" width="50%"/>
3+
</p>
4+
5+
# BENEFICIARIES
6+
7+
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.
8+
9+
10+
11+
## Create a beneficiary
12+
13+
This describes how to create a transfer beneficiary
14+
```java
15+
Response flwResponse = new Beneficiaries()
16+
.runCreateBeneficiary(new BeneficiaryRequest("0690000034",
17+
"044",
18+
"Ade Bond",
19+
Optional.empty(),
20+
Optional.empty()));
21+
```
22+
23+
## List all Transfer Beneficiaries
24+
25+
This describes how to list all transfer beneficiaries
26+
```java
27+
ListResponse flwResponse = new Beneficiaries()
28+
.runGetAllBeneficiaries(Optional.page);
29+
```
30+
31+
## Fetch a Transfer Beneficiary
32+
33+
This describes how to fetch a transfer beneficiary
34+
```java
35+
Response flwResponse = new Beneficiaries()
36+
.runGetBeneficiary(Optional.id);
37+
```
38+
39+
## Delete a Transfer Beneficiary
40+
41+
This describes how to delete a transfer beneficiary
42+
```java
43+
Response flwResponse = new Beneficiaries()
44+
.runDeleteBeneficiary(Optional.id);
45+
```

‎documentation/Bills.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ Response response = new Bills()
6464
.getBills(from, to);
6565
```
6666
67-
## Get status of a bill payment
67+
## Get actions of a bill payment
6868
69-
This describes how to get status of a bill payment
69+
This describes how to get actions of a bill payment
7070
7171
```java
7272
Response response = new Bills().getStatus(id);

‎documentation/CardIssuing.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<p align="center">
2+
<img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo/full.svg" width="50%"/>
3+
</p>
4+
5+
# Card Issuing
6+
7+
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.
8+
9+
10+
## VIRTUAL CARDS
11+
12+
## Create virtual card
13+
14+
This describes how to create a new virtual card
15+
16+
```java
17+
Response flwResponse = new VirtualCard()
18+
.runCreateVirtualCard(new VirtualCardRequest("USD",
19+
new BigDecimal("5"),
20+
"NGN",
21+
"Example User.",
22+
"333, Fremont Street",
23+
"San Francisco",
24+
"CA",
25+
"94105",
26+
"US",
27+
"Example",
28+
"User",
29+
"1996/12/30",
30+
"userg@example.com",
31+
"07030000000",
32+
"MR",
33+
"M",
34+
"https://webhook.site/b67965fa-e57c-4dda-84ce-0f8d6739b8a5"));
35+
```
36+
37+
## Get All Virtual Cards
38+
39+
This describes how to get all virtual cards
40+
41+
```java
42+
ListResponse flwResponse = new VirtualCard()
43+
.runGetAllVirtualCards();
44+
```
45+
46+
## Get A Virtual Card
47+
48+
This describes how to get a virtual cards
49+
50+
```java
51+
Response flwResponse = new VirtualCard()
52+
.runGetVirtualCard(id);
53+
```
54+
55+
## Fund A Virtual Card
56+
57+
This describes how to fund a virtual cards
58+
59+
```java
60+
Response flwResponse = new VirtualCard()
61+
.runFundVirtualCard(
62+
id,
63+
new FundVirtualCardRequest(
64+
"USD",
65+
new BigDecimal("500"))
66+
);
67+
```
68+
69+
## Withdraw From A Virtual Card
70+
71+
This describes how to wihdraw from a virtual card
72+
73+
```java
74+
ListResponse flwResponse = new VirtualCard()
75+
.runWithdrawVirtualCard("", new BigDecimal("200"));
76+
```
77+
78+
## Block/Unblock Virtual Card
79+
80+
This describes how to block/unblock a virtual card
81+
82+
```java
83+
Response flwResponse = new VirtualCard()
84+
.runStatusVirtualCard("", BLOCK);
85+
```
86+
87+
## Terminate A Virtual Card
88+
89+
This describes how to terminate a virtual card
90+
91+
```java
92+
Response flwResponse = new VirtualCard()
93+
.runTerminateVirtualCard("");
94+
```
95+
96+
## Get A Virtual Card's Transactions
97+
98+
This describes how to get a virtual cards' transaction
99+
100+
```java
101+
ListResponse flwResponse = new VirtualCard()
102+
.runTerminateVirtualCard("");
103+
```

‎documentation/Collections.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Response flwResponse = new MobileMoney().runGhanaMobileMoneyTransaction(new Ghan
187187
Sample Response
188188
```json
189189
{
190-
"status": "success",
190+
"actions": "success",
191191
"message": "Charge initiated",
192192
"meta": {
193193
"authorization": {

‎documentation/ScheduledPayments.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<p align="center">
2+
<img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo/full.svg" width="50%"/>
3+
</p>
4+
5+
# Scheduled payments
6+
7+
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.

‎documentation/Settlements.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<p align="center">
2+
<img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo/full.svg" width="50%"/>
3+
</p>
4+
5+
# SETTLEMENTS
6+
7+
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.
8+
9+
10+
## Get all settlements
11+
12+
This describes how to fetch all settlements
13+
14+
```java
15+
ListResponse flwResponse = new Settlements()
16+
.runGetAllSettlements(Optional.empty(),
17+
Optional.empty(),
18+
Optional.empty(),
19+
Optional.empty());
20+
```
21+
22+
## Get a settlement
23+
24+
This describes how to get a settlement
25+
26+
```java
27+
ListResponse flwResponse = new Settlements()
28+
.runGetSettlement(id,
29+
Optional.empty(),
30+
Optional.empty());
31+
```

‎documentation/Tokenization.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ ListResponse flwResponse = new TokenizedCharge()
4646
.runGetBulkTransaction(id);
4747
```
4848

49-
## Get status of bulk Tokenized Charges
49+
## Get actions of bulk Tokenized Charges
5050

5151
This describes how to get bulk tokenized charge
5252

‎documentation/Transfers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This describes how to get all transfers
6060
```java
6161
Response flwResponse = new Transfer()
6262
.getAllTransfers(Optional.page,
63-
Optional.status);
63+
Optional.actions);
6464
```
6565

6666
## Fetch a Transfer

0 commit comments

Comments
 (0)