diff --git a/README.md b/README.md index 2569309..7a72314 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 @@ -68,7 +68,7 @@ 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"); @@ -76,8 +76,8 @@ The foloowing environment variables need to be set before calling any method 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. @@ -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:developers@flutterwavego.com) or on [slack](https://bit.ly/34Vkzcg). +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). You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊. diff --git a/documentation/Banks.md b/documentation/Banks.md index 6c565c3..10e5e57 100644 --- a/documentation/Banks.md +++ b/documentation/Banks.md @@ -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 @@ -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) -``` \ No newline at end of file +``` diff --git a/documentation/Beneficiary.md b/documentation/Beneficiary.md index 9d19582..1a41e49 100644 --- a/documentation/Beneficiary.md +++ b/documentation/Beneficiary.md @@ -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", @@ -22,7 +22,7 @@ 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); @@ -30,7 +30,7 @@ ListResponse flwResponse = new Beneficiaries() ## 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); @@ -38,8 +38,8 @@ Response flwResponse = new Beneficiaries() ## 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); -``` \ No newline at end of file +``` diff --git a/documentation/Bills.md b/documentation/Bills.md index 125782b..60f4e12 100644 --- a/documentation/Bills.md +++ b/documentation/Bills.md @@ -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, @@ -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() @@ -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", @@ -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 billRequestList = new ArrayList<>(); @@ -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); -``` \ No newline at end of file +``` diff --git a/documentation/CardIssuing.md b/documentation/CardIssuing.md index 1329fd9..23ef61d 100644 --- a/documentation/CardIssuing.md +++ b/documentation/CardIssuing.md @@ -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() @@ -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() @@ -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() @@ -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() @@ -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() @@ -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() @@ -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() @@ -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(""); -``` \ No newline at end of file +``` diff --git a/documentation/Collections.md b/documentation/Collections.md index f5e12cc..f91158a 100644 --- a/documentation/Collections.md +++ b/documentation/Collections.md @@ -4,8 +4,8 @@ # Collections -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. + Collect payments from your users via any of these methods: @@ -13,31 +13,31 @@ Collect payments from your users via any of these methods: 2. [Bank transfers](#bank-transfers) 3. [Direct debit (Nigerian bank accounts)](#direct-debit-nigerian-bank-account) 4. [Direct debit (UK bank accounts)](#direct-debit-uk-bank-account) -5. ACH payments -6. Mpesa -7. Ghana Mobile Money -8. Uganda Mobile Money -9. Rwanda Mobile Money -10. Zambia Mobile Money -11. Francophone Mobile Money (for Senegal, Cote D'Ivoire, Mali and Cameroon). -12. USSD -13. Applepay -14. Googlepay -15. Paypal -16. Fawrypay +5. [ACH payment](#ach-payment) +6. [Mpesa](#mpesa) +7. [Ghana Mobile Money](#ghana-mobile-money) +8. [Uganda Mobile Money](#uganda-mobile-money) +9. [Rwanda Mobile Money](#rwanda-mobile-money) +10. [Zambia Mobile Money](#zambia-mobile-money) +11. [Francophone Mobile Money (for Senegal, Côte d'Ivoire, Mali, and Cameroon)](#francophone-mobile-money). +12. [USSD](#ussd) +13. [Apple Pay](#applepay) +14. [Google Pay](#googlepay) +15. [PayPal](#paypal) +16. [Fawrypay](fawrypay) There are three steps involved in collecting payments from your users: -- Initating the transaction. +- Initiating the transaction. - Authorizing the transaction. - Verifying the transaction. -Read more about the steps [here](https://developer.flutterwave.com/docs/direct-charge/overview) +Read more about the steps [here](https://developer.flutterwave.com/v3.0.0/docs/direct-card-charge#payment-flow). ## Card Collections -This section describes how you can collect card payments in the SDK. You can learn more about the payment -method [here](https://developer.flutterwave.com/docs/direct-charge/card). +This section describes how you can collect card payments in the SDK. You can learn more about the payment. +method [here](https://developer.flutterwave.com/v3.0.0/docs/direct-card-charge). ```java Optional.ofNullable(new CardCharge() @@ -80,7 +80,7 @@ Optional.ofNullable(new CardCharge() ## Preauth Collections This section describes how you can collect card preauth payments in the SDK. You can learn more about the payment -method [here](https://developer.flutterwave.com/docs/direct-charge/card). +method [here](https://developer.flutterwave.com/v3.0.0/docs/preauthorization). ```java Response flwResponse=new PreAuthorization( @@ -100,8 +100,8 @@ Response flwResponse=new PreAuthorization( ## Bank Transfers -This section covers how you can collect payments made via bank transfers. We go into more details on the payment flow -itself [here](https://developer.flutterwave.com/docs/direct-charge/bank-transfer). +This section covers how you can collect payments made via bank transfers. We go into more detail on the payment flow. +itself [here](https://developer.flutterwave.com/v3.0.0/docs/bank-transfer-1). ```java Response flwResponse=new BanKTransfer() @@ -147,10 +147,10 @@ Response flwResponse=new BankAccount() ); ``` -## ACH Payement +## ACH Payment This shows you how to accept ZAR and USD ACH charges from your customers. Read more about ACH -payments [here](https://developer.flutterwave.com/docs/direct-charge/ach-payment). +payments [here](https://developer.flutterwave.com/v3.0.0/docs/ach-payment). ```java Response flwResponse=new ACH() @@ -170,7 +170,7 @@ Response flwResponse=new ACH() ## USSD -This describes how to collect payments via ussd +This describes how to collect payments via USSD. ```java Response flwResponse=new USSD().runTransaction(new USSDRequest("MC-15852309v5050e8y", @@ -185,8 +185,8 @@ Response flwResponse=new USSD().runTransaction(new USSDRequest("MC-15852309v5050 ## Mpesa -This describes how to collect payments via Mpesa. Read more about Mpesa -payments [here](https://developer.flutterwave.com/docs/direct-charge/mpesa). +This describes how to collect payments via M-Pesa. Read more about M-Pesa. +payments [here](https://developer.flutterwave.com/v3.0.0/docs/m-pesa). ```java Response flwResponse=new MobileMoney().runMpesaTransaction(new MpesaRequest("MC-15852113s09v5050e8", @@ -232,7 +232,7 @@ Sample Response } ``` -**Redirect customer to the redirect link returned in the charge initiation response.** +**Redirect your customer to the redirect link returned in the charge initiation response.** **NB: OTP on staging (TEST MODE) is `123456`** ## Rwanda mobile money @@ -309,7 +309,7 @@ Response flwResponse=new MobileMoney() ## Applepay -This describes how to collect payments via Applepay. +This describes how to collect payments via Apple Pay. ```java Response flwResponse=new ApplePay().runTransaction(new ApplePayRequest("MC-TEST-123456", @@ -331,7 +331,7 @@ Response flwResponse=new ApplePay().runTransaction(new ApplePayRequest("MC-TEST- ## Googlepay -This describes how to collect payments via Googlepay. +This describes how to collect payments via Google Pay. ```java Response flwResponse=new GooglePay().runTransaction(new GooglePayRequest("MC-TEST-123456", @@ -353,7 +353,7 @@ Response flwResponse=new GooglePay().runTransaction(new GooglePayRequest("MC-TES ## Paypal -This describes how to collect payments via Paypal. +This describes how to collect payments via PayPal. ```java Response flwResponse=new Paypal().runTransaction(new PaypalRequest( @@ -394,4 +394,4 @@ Response flwResponse=new FawryPay().runTransaction(new FawryPayRequest("fawrySam "https://www.flutterwave.com", Optional.empty() )); -``` \ No newline at end of file +``` diff --git a/documentation/Misc.md b/documentation/Misc.md index 87e7096..e77c703 100644 --- a/documentation/Misc.md +++ b/documentation/Misc.md @@ -4,11 +4,11 @@ # MISC -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. ### Resolve account details -This describes how to resolve a bank account to get the account holder's details +This describes how to resolve a bank account to get the account holder's details. ```java Response flwResponse = new ResolveAccount() @@ -20,11 +20,11 @@ Response flwResponse = new ResolveAccount() )); ``` -### Resolve bvn details +### Resolve BVN details -This describes how to fetch bvn information +This describes how to fetch BVN information. ```java Response flwResponse = new ResolveBVN(). runTransaction("123456789010"); -``` \ No newline at end of file +``` diff --git a/documentation/OTP.md b/documentation/OTP.md index b779057..e8a1775 100644 --- a/documentation/OTP.md +++ b/documentation/OTP.md @@ -4,12 +4,12 @@ # OTPS -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 Otp -This describes how to create an otp +This describes how to create an otp. ```java List mediumList = new ArrayList<>(); @@ -28,10 +28,10 @@ ListResponse flwResponse = new OTP().runCreateOTP(new OTPRequest(new Customer( ### Validate Otp -This describes how to validate an otp +This describes how to validate an otp. ```java Response flwResponse = new OTP().runValidateOTP( "CF-BARTER-20221203111843688560", "6834919"); -``` \ No newline at end of file +``` diff --git a/documentation/PaymentPlans.md b/documentation/PaymentPlans.md index 6a68b33..9956056 100644 --- a/documentation/PaymentPlans.md +++ b/documentation/PaymentPlans.md @@ -4,13 +4,13 @@ # Payment plans -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 Payment Plan -This describes how to create a payment plan +This describes how to create a payment plan. ```java Response flwResponse = new PaymentPlan() @@ -22,7 +22,7 @@ Response flwResponse = new PaymentPlan() ## Get payment plans -This describes how to get payment plans +This describes how to get payment plans. ```java ListResponse flwResponse = new PaymentPlan() @@ -31,7 +31,7 @@ ListResponse flwResponse = new PaymentPlan() ## Get a Payment Plan -This describes how to get a payment plan +This describes how to get a specific payment plan using its ID. ```java ListResponse flwResponse = new PaymentPlan() @@ -40,7 +40,7 @@ ListResponse flwResponse = new PaymentPlan() ## Update a Payment Plan -This describes how to update a payment plan +This describes how to update a payment plan. ```java ListResponse flwResponse = new PaymentPlan() @@ -50,9 +50,9 @@ ListResponse flwResponse = new PaymentPlan() ## Cancel a Payment Plan -This describes how to cancel a payment plan +This describes how to cancel a payment plan. ```java ListResponse flwResponse = new PaymentPlan() .cancelPlan(id); -``` \ No newline at end of file +``` diff --git a/documentation/ScheduledPayments.md b/documentation/ScheduledPayments.md index 7fa4881..3cb268b 100644 --- a/documentation/ScheduledPayments.md +++ b/documentation/ScheduledPayments.md @@ -4,4 +4,4 @@ # Scheduled payments -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. diff --git a/documentation/Settlements.md b/documentation/Settlements.md index 0f8e2f8..01ef830 100644 --- a/documentation/Settlements.md +++ b/documentation/Settlements.md @@ -4,12 +4,12 @@ # SETTLEMENTS -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 settlements -This describes how to fetch all settlements +This describes how to fetch all settlements. ```java ListResponse flwResponse = new Settlements() @@ -21,11 +21,11 @@ ListResponse flwResponse = new Settlements() ## Get a settlement -This describes how to get a settlement +This describes how to get a settlement. ```java ListResponse flwResponse = new Settlements() .runGetSettlement(id, Optional.empty(), Optional.empty()); -``` \ No newline at end of file +``` diff --git a/documentation/SubAccounts.md b/documentation/SubAccounts.md index c8c0bb8..fd26267 100644 --- a/documentation/SubAccounts.md +++ b/documentation/SubAccounts.md @@ -4,12 +4,12 @@ # SubAccounts -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 Collection Subaccounts -This describes how to create a collection subaccount +This describes how to create a collection subaccount. ```java Response flwResponse = new SubAccounts() @@ -31,7 +31,7 @@ Response flwResponse = new SubAccounts() ## Create Payout Subaccounts -This describes how to create a payout subaccount +This describes how to create a payout subaccount. ```java Response flwResponse = new SubAccounts() @@ -43,7 +43,7 @@ Response flwResponse = new SubAccounts() ## Fetch collection subaccounts -This describes how to create a fetch collection subaccounts +This describes how to fetch a collection subaccount. ```java Response flwResponse = new SubAccounts() @@ -57,7 +57,7 @@ Response flwResponse = new SubAccounts() ## Fetch payout subaccounts -This describes how to create a fetch payout subaccounts +This describes how to fetch payout subaccounts. ```java Response flwResponse = new SubAccounts() @@ -72,7 +72,7 @@ Response flwResponse = new SubAccounts() ## Fetch a collection subaccount -This describes how to create a fetch a collection subaccount +This describes how to fetch a specific collection subaccount using the ID. ```java Response flwResponse = new SubAccounts() @@ -85,7 +85,7 @@ Response flwResponse = new SubAccounts() ## Update a collection subaccount -This describes how to create a fetch a collection subaccount +This describes how to update a collection subaccount. ```java Response flwResponse = new SubAccounts() @@ -99,9 +99,9 @@ Response flwResponse = new SubAccounts() ## Delete a subaccount -This describes how to create a delete a collection subaccount +This describes how to delete a collection subaccount. ```java Response flwResponse = new SubAccounts() .runDeleteCollectionSubAccounts(18504); -``` \ No newline at end of file +``` diff --git a/documentation/Subscriptions.md b/documentation/Subscriptions.md index a8dd23b..0ea774a 100644 --- a/documentation/Subscriptions.md +++ b/documentation/Subscriptions.md @@ -4,13 +4,13 @@ # Subscriptions -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 subscriptions -This describes how to get all subscriptions +This describes how to get all subscriptions. ```java ListResponse flwResponse = new Subscriptions() @@ -19,7 +19,7 @@ ListResponse flwResponse = new Subscriptions() ## Activate a Subscription -This describes how to activate a subscription +This describes how to activate a subscription. ```java Response flwResponse = new Subscriptions(). @@ -28,9 +28,9 @@ Response flwResponse = new Subscriptions(). ## Deactivate a Subscription -This describes how to activate a subscription +This describes how to deactivate a subscription. ```java Response flwResponse = new Subscriptions(). deactivateSubscription(id); -``` \ No newline at end of file +``` diff --git a/documentation/Tokenization.md b/documentation/Tokenization.md index 019a849..d8fc471 100644 --- a/documentation/Tokenization.md +++ b/documentation/Tokenization.md @@ -4,11 +4,11 @@ # Tokenization -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 Tokenized Charge -This describes how to create a tokenized charge +This describes how to create a tokenized charge. ```java @@ -27,7 +27,7 @@ Response flwResponse = new TokenizedCharge() ## Create bulk Tokenized Charges -This describes how to create a bulk tokenized charge +This describes how to create a bulk tokenized charge. ```java List tokenizedChargeRequestList= new ArrayList<>(); @@ -39,7 +39,7 @@ Response flwResponse = new TokenizedCharge() ## Get bulk Tokenized Charges -This describes how to get bulk tokenized charge +This describes how to get a bulk tokenized charge. ```java ListResponse flwResponse = new TokenizedCharge() @@ -48,7 +48,7 @@ ListResponse flwResponse = new TokenizedCharge() ## Get actions of bulk Tokenized Charges -This describes how to get bulk tokenized charge +This describes how to get a bulk tokenized charge. ```java Response flwResponse = new TokenizedCharge() @@ -57,7 +57,7 @@ Response flwResponse = new TokenizedCharge() ## Update Card token -This describes how to update card token +This describes how to update the card token. ```java Response flwResponse = new TokenizedCharge() @@ -65,4 +65,4 @@ Response flwResponse = new TokenizedCharge() new UpdateTokenRequest("user@example.com", "Kendrick Graham", "0813XXXXXXX")); -``` \ No newline at end of file +``` diff --git a/documentation/Transactions.md b/documentation/Transactions.md index 6d894a2..fd51ebd 100644 --- a/documentation/Transactions.md +++ b/documentation/Transactions.md @@ -4,11 +4,11 @@ # Transactions -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. ## Verify a transaction -This describes how to verify a transaction +This describes how to verify a transaction. ```java @@ -18,7 +18,7 @@ Response flwResponse = new Transactions() ## Create a Refund -This describes how to create a refund +This describes how to create a refund. ```java @@ -29,7 +29,7 @@ Response flwResponse = new Transactions() ## Get multiple Transactions -This describes how to get multiple transactions +This describes how to get multiple transactions. ```java @@ -39,7 +39,7 @@ ListResponse flwResponse = new Transactions() ## Get multiple refund transactions -This describes how to get multiple refund transactions +This describes how to get multiple refund transactions. ```java @@ -50,7 +50,7 @@ ListResponse flwResponse = new Transactions() ## Get refund details -This describes how to get refund details +This describes how to get refund details. ```java @@ -60,7 +60,7 @@ Response flwResponse = new Transactions() ## Get transactions fees (Collections) -This describes how to get transaction fee +This describes how to get the transaction fee. ```java @@ -71,7 +71,7 @@ Response flwResponse = new Transactions() ## Resend failed Webhooks -This describes how to resend failed webhooks +This describes how to resend failed webhooks. ```java @@ -82,9 +82,9 @@ Response flwResponse = new Transactions() ## View transaction timeline -This describes how to view transaction timeline +This describes how to view the transaction timeline. ```java Response flwResponse = new Transactions().runViewTimeline(id); -``` \ No newline at end of file +``` diff --git a/documentation/Transfers.md b/documentation/Transfers.md index 469dafb..3bf708a 100644 --- a/documentation/Transfers.md +++ b/documentation/Transfers.md @@ -4,13 +4,13 @@ # TRANSFERS -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 transfer This describes how to initiate a transfer -For more info about the payload parameteres definition, check [here](https://developer.flutterwave.com/reference#create-a-transfer) +For more info about the payload parameters definition, check [here](https://developer.flutterwave.com/v3.0.0/reference/create-a-transfer). ```java Response flwResponse = new Transfer() @@ -26,7 +26,7 @@ Response flwResponse = new Transfer() ## Retry a Transfer -This describes how to retry a transfer +This describes how to retry a transfer. ```java Response flwResponse = new Transfer().retry(id); @@ -34,7 +34,7 @@ Response flwResponse = new Transfer().retry(id); ## Create a Bulk transfer -This describes how to create a bulk transfer +This describes how to create a bulk transfer. ```java List transferRequestList = new ArrayList<>(); @@ -46,7 +46,7 @@ Response flwResponse = new Transfer() ## Get Transfer fees -This describes how to get a transfer fee +This describes how to get a transfer fee. ```java Response flwResponse = new Transfer() @@ -55,7 +55,7 @@ Response flwResponse = new Transfer() ## Get all Transfers -This describes how to get all transfers +This describes how to get all transfers. ```java Response flwResponse = new Transfer() @@ -65,7 +65,7 @@ Response flwResponse = new Transfer() ## Fetch a Transfer -This describes how to get all transfers +This describes how to get all transfers. ```java Response flwResponse = new Transfer().getTransfer(id); @@ -73,10 +73,10 @@ Response flwResponse = new Transfer().getTransfer(id); ## Get Transfer Rates -This describes how to get transfer rates +This describes how to get transfer rates. ```java Response flwResponse = new Transfer() .getTransferRate(new BigDecimal("200"), "USD", "NGN"); -``` \ No newline at end of file +``` diff --git a/documentation/VirtualAccount.md b/documentation/VirtualAccount.md index 561cdff..74e48a2 100644 --- a/documentation/VirtualAccount.md +++ b/documentation/VirtualAccount.md @@ -4,15 +4,15 @@ # VIRTUAL ACCOUNT NUMBERS -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 virtual account number -This describes how to create a virtual account number +This describes how to create a virtual account number. -Note: BVN is required for creating static account numbers in the Live Environment i.e if the value of is_permanent is True. -Kindly visit our API section found [here](https://developer.flutterwave.com/reference#create-a-virtual-account-number-1) for more information. +Note: BVN is required for creating static account numbers in the Live Environment, i.e, if the value of is_permanent is True. +Kindly visit our API section found [here](https://developer.flutterwave.com/v3.0.0/reference/create-a-virtual-account-number-1) for more information. ```java Response flwResponse = new VirtualAccount() @@ -26,7 +26,7 @@ Response flwResponse = new VirtualAccount() ## Get a virtual account number -This describes how to fetch a virtual account number using order reference +This describes how to fetch a virtual account number using the order reference. ```java Response flwResponse = new VirtualAccount() @@ -35,9 +35,9 @@ Response flwResponse = new VirtualAccount() ## update BVN -This describes how to update the bvn linked to a virtual account number +This describes how to update the BVN linked to a virtual account number. ```java Response flwResponse = new VirtualAccount() .updateBVN(reference, bvn); -``` \ No newline at end of file +```