Skip to content

Commit 621878c

Browse files
committed
[README]Update Broken Links And Improved Grammar.
Updated the broken links in the readme sections. I also improved the grammar where i thought necessary.
1 parent 0a57fd6 commit 621878c

File tree

3 files changed

+119
-87
lines changed

3 files changed

+119
-87
lines changed

ChargeVerificationUtils.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Charge Verification Utils
2-
This module helps you handle charge verification when not using the default drop-in UI provided by Flutterwave's android SDK.
2+
This module helps you in handling charge verification when you are not using the default drop-in UI provided by Flutterwave's Android SDK.
33

4-
**Step 1.** Add this in your root build.gradle at the end of repositories:
4+
**Step 1.** Add the following in your root build.gradle file at the end of the `repositories` section:
55

66
allprojects {
77
repositories {
@@ -10,22 +10,22 @@ This module helps you handle charge verification when not using the default drop
1010
}
1111
}
1212

13-
**Step 2.** Add the dependency for the utils library
13+
**Step 2.** Add the dependency for the utils library:
1414

1515
dependencies {
1616
implementation 'com.github.Flutterwave.rave-android:rave_utils:2.1.39'
1717
}
1818

19-
**Step 2.** In your payment activity or fragment, create an instance of the `RaveVerificationUtils` class
19+
**Step 2.** In your payment activity or fragment, create an instance of the `RaveVerificationUtils` class.
2020

2121
RaveVerificationUtils verificationUtils = new RaveVerificationUtils(contextProvider, isStaging, publicKey, theme);
2222

2323
##### Parameter definitions
2424
| Parameter Name | Description | Type | Required |
2525
| ------------- |:-------------:| -----:| -----:|
26-
| contextProvider | This is the application or fragment class where you're handling the charge verification. | `Activity` or `Fragment` | Required
27-
| isStaging | Specifies whether it's the staging or live environment. | `Boolean` | Required
28-
| publicKey | Your Flutterwave account's public key. | `String` | Required
26+
| contextProvider | This is the application or fragment class handling charge verification. | `Activity` or `Fragment` | Required
27+
| isStaging | This Specifies if the environment is test or live. | `Boolean` | Required
28+
| publicKey | Your Flutterwave public key. | `String` | Required
2929
| theme | Reference to your custom style. | `int` | Not required
3030

3131
**Step 3** You can call the verification class for these scenarios:
@@ -35,7 +35,7 @@ This module helps you handle charge verification when not using the default drop
3535
verificationUtils.showPinScreen();
3636
3737
// For OTP collection
38-
verificationUtils.showOtpScreen(instructionToBeDisplayed); // instruction parameter is optional
38+
verificationUtils.showOtpScreen(instructionToBeDisplayed); // The instruction parameter is optional
3939
4040
// For Address collection
4141
verificationUtils.showAddressScreen();

CustomUiImplementation.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Custom UI Implementation
2-
The Flutterwave SDK can be used with your custom UI where you handle the entire User Interface. This doc shows how to do so.
2+
The Flutterwave SDK can be integrated with your custom UI, allowing you to manage the entire User Interface. This section provides guidance on how to implement this.
33

44
### 1. Create a `RaveNonUIManager` instance
5-
Set the public key, encryption key and other required parameters.
5+
Begin by creating an instance of `RaveNonUIManager` and setting the public and encryption key, along with other required parameters.
66

77
RaveNonUIManager raveNonUIManager =
88
new RaveNonUIManager()
@@ -30,22 +30,23 @@ Set the public key, encryption key and other required parameters.
3030

3131
| Function | Parameter | Type | Required |
3232
| ------------- |:-------------:| -----:| -----:|
33-
| setAmount(amount) | This is the amount to be charged from card/account | `double` | Required
34-
| setCurrency(currency) | This is the specified currency to charge the card in | `String` | Required
35-
| setfName(fName) | This is the first name of the card holder or the customer | `String` | Required
36-
| setlName(lName) | This is the last name of the card holder or the customer | `String` | Required
37-
| setEmail(email) | This is the email address of the customer | `String` | Required
38-
| setNarration(narration) | This is a custom description added by the merchant. For `Bank Transfer` payments, this becomes the account name of the account to be paid into. See more details [here](https://developer.flutterwave.com/v2.0/reference#pay-with-bank-transfer-nigeria). | `String` | Not Required
39-
| setPublicKey(publicKey) | Merchant's public key. Get your merchant keys here for [ staging](https://flutterwavedevelopers.readme.io/blog/how-to-get-your-staging-keys-from-the-rave-sandbox-environment) and [live](https://flutterwavedevelopers.readme.io/blog/how-to-get-your-live-keys-from-the-rave-dashboard)| `String` | Required
40-
| setEncryptionKey(encryptionKey) | Merchant's encryption key. Get your merchant keys here for [ staging](https://flutterwavedevelopers.readme.io/blog/how-to-get-your-staging-keys-from-the-rave-sandbox-environment) and [live](https://flutterwavedevelopers.readme.io/blog/how-to-get-your-live-keys-from-the-rave-dashboard) | `String` | Required
41-
| setTxRef(txRef) | This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction | `String` | Required
42-
| setPhoneNumber(phoneNumber) | This sets the customer's phone number. This functions is also overloaded to allow you specify whether the customer can edit their phone number as such: `setPhoneNumber(phoneNumber,false)`. When set to false, the user will not be able to change the number you set here.| `String`<br/><br/>Optional overloads:<br/>`String`, `boolean` | Not Required
43-
| onStagingEnv(boolean) | Set to `true` if you want your transactions to run in the staging environment otherwise set to `false`. Defaults to false | `boolean` | Not Required
44-
| setMeta(`List<Meta>`) | Pass in any other custom data you wish to pass. It takes in a `List` of `Meta` objects | List<Meta> | Not Required
45-
| setSubAccounts(`List<SubAccount>`) | Pass in a `List` of `SubAccount`,if you want to split transaction fee with other people. Subaccounts are your vendors' accounts that you want to settle per transaction. To initialize a `SubAccount` class, do `SubAccount(String subAccountId,String transactionSplitRatio)` or `SubAccount(String subAccountId,String transactionSplitRatio,String transactionChargeType, String transactionCharge)` to also charge the subaccount a fee. [Learn more about split payments and subaccounts](https://developer.flutterwave.com/docs/split-payment).| `List<SubAccount>`| Not Required
46-
| setIsPreAuth(boolean) | Set to `true` to preauthorise the transaction amount. [Learn more about preauthourization](https://developer.flutterwave.com/v2.0/reference#introduction-1). | `int` | Not Required
47-
| setPaymentPlan(payment_plan) | If you want to do recurrent payment, this is the payment plan ID to use for the recurring payment, you can see how to create payment plans [here](https://flutterwavedevelopers.readme.io/v2.0/reference#create-payment-plan) and [here](https://flutterwavedevelopers.readme.io/docs/recurring-billing). This is only available for card payments | `String` | Not Required
48-
| initialize() | Returns the prepared `RaveNonUiManager` that can be used with any of the payment managers for the different payment methods | N/A | Required
33+
| setAmount(amount) | This sets the amount to be charged from the customer. | `double` | Required
34+
| setCurrency(currency) | This sets the specified currency to charge the customer in. | `String` | Required
35+
| setfName(fName) | This sets the first name of the customer. | `String` | Required
36+
| setlName(lName) | This sets the last name of the customer. | `String` | Required
37+
| setEmail(email) | This sets the email address of the customer. | `String` | Required
38+
| setNarration(narration) | This sets a custom description added by the merchant. For `Bank Transfer` payments, this will be shown to the customer as the account name when the account number is resolved. | `String` | Not Required
39+
| setPublicKey(publicKey) | This sets the Merchant's public key. Get your live and test public key from your dashboard [here](https://app.flutterwave.com/login). For further information on how to retrieve your keys, visit [here](https://flutterwave.com/gh/support/my-account/getting-your-api-keys).| `String` | Required
40+
| setEncryptionKey(encryptionKey) | This sets the Merchant's encryption key. Get your live and test encryption key from your dashboard [here](https://dashboard.flutterwave.com/login). For further information on how to retrieve your keys, visit [here](https://flutterwave.com/gh/support/my-account/getting-your-api-keys). | `String` | Required
41+
| setTxRef(txRef) | This is the unique reference, specific to the particular transaction being carried out. It should be generated by the merchant for each transaction. | `String` | Required
42+
| setPhoneNumber(phoneNumber) | This sets the customer's phone number. This functions has an overload to specify whether the customer can edit their phone number. `setPhoneNumber(phoneNumber,false)`. When set to false, the customer is unable to change the phone number provided.| `String`<br/><br/>Optional overloads:<br/>`String`, `boolean` | Not Required
43+
| onStagingEnv(boolean) | Set to `true` to carry out test transactions in the staging environment; otherwise the default value
44+
is `false`. | `boolean` | Not Required
45+
| setMeta(`List<Meta>`) | Adds custom data to be passed. It accepts a `List` of `Meta` objects | List<Meta> | Not Required
46+
| setSubAccounts(`List<SubAccount>`) | Accepts a `List` of `SubAccount`, if you want to split transaction fee with other accounts. Subaccounts are vendors' accounts to be settled per transaction. To initialize a `SubAccount` class, use `SubAccount(String subAccountId, String transactionSplitRatio)` or `SubAccount(String subAccountId, String transactionSplitRatio, String transactionChargeType, String transactionCharge)` to also charge the subaccount a fee. [Learn more about split payments and subaccounts](https://flutterwave.com/eg/support/payments/split-payments-with-sub-accounts).| `List<SubAccount>`| Not Required
47+
| setIsPreAuth(boolean) | Set to `true` to preauthorise the transaction amount. [Learn more about preauthourization](https://flutterwave.com/ci/blog/a-developers-guide-to-implementing-card-pre-authorization-charges-with-flutterwave). | `int` | Not Required
48+
| setPaymentPlan(payment_plan) | If you want set up recurrent payments, this is the payment plan ID to use. For guidance on creating payment plans visit [here](https://flutterwave.com/gb/support/my-account/creating-and-cancelling-payment-plans). Reucurring payment is only available for card payments | `String` | Not Required
49+
| initialize() | Returns the prepared `RaveNonUiManager` that can be used with any of the payment managers for the different payment methods. | N/A | Required
4950
</details>
5051

5152
### 2. Initiate a charge
@@ -63,7 +64,7 @@ Use the payment method's manager to initiate a charge. For example to charge car
6364
cardPayManager.chargeCard(card);
6465

6566
### 3. Implement callbacks
66-
We have predefined callback classes for each payment method. Make your Fragment/Activity (or other class handling the payment interaction) implement the specified callback for the payment method you'd like to use, and override the specified callback functions. For example to charge cards, implement the `CardPaymentCallback`
67+
We have predefined callback classes for each payment method. Make your Fragment/Activity (or other class handling the payment interaction) implement the specified callback for the payment method you'd like to use, and override the specified callback functions. For example to charge cards, implement the `CardPaymentCallback`.
6768
<details>
6869
<summary>See Example</summary>
6970

@@ -140,14 +141,14 @@ We have predefined callback classes for each payment method. Make your Fragment/
140141
| Zambia Mobile Money | `ZmMobileMoneyPaymentManager` | `ZmMobileMoneyPaymentCallback`
141142
</details>
142143

143-
> We worked on a module to simplify charge verification when using the No-UI approach. You can read about using it [here](ChargeVerificationUtils.md)
144+
> We worked on a module to simplify charge verification when using the No-UI approach. You can read about using it [here](ChargeVerificationUtils.md).
144145
145146
> Due to the multiple payment methods available, all the methods of the different payment callback classes could not be documented here. Please refer to the individual Javadocs in the code if clarification is needed.
146147
147-
> To see a more practical way of using the sdk, head to our sample app in the repository [here](https://github.com/Flutterwave/rave-android/tree/master/app)
148+
> To see a more practical way of using the SDK, head to our sample app in the repository [here](https://github.com/Flutterwave/rave-android/tree/master/app).
148149
149150
## Configuring Proguard
150-
To configure Proguard, add the following lines to your proguard configuration file. These will keep files related to this sdk
151+
To configure Proguard, add the following lines to your proguard configuration file. These will keep files related to this SDK.
151152
```
152153
keepclasseswithmembers public class com.flutterwave.raveandroid.** { *; }
153154
dontwarn com.flutterwave.raveandroid.card.CardFragment

0 commit comments

Comments
 (0)