Skip to content

Commit df71adf

Browse files
committed
update readme
1 parent 985c529 commit df71adf

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The minimum supported SDK version is 15
2828
**Step 2.** Add the dependency
2929

3030
dependencies {
31-
compile 'com.github.Flutterwave:rave-android:1.0.28'
31+
implementation 'com.github.Flutterwave:rave-android:1.0.31'
3232
}
3333

3434
**Step 3.** Add the required permission
@@ -55,7 +55,7 @@ Set the public key, private key and other required parameters. The `RavePayManag
5555
.setlName(lName)
5656
.setNarration(narration)
5757
.setPublicKey(publicKey)
58-
.setSecretKey(secretKey)
58+
.setEncryptionKey(encryptionKey)
5959
.setTxRef(txRef)
6060
.acceptAccountPayments(boolean)
6161
.acceptCardPayments(boolean)
@@ -65,8 +65,8 @@ Set the public key, private key and other required parameters. The `RavePayManag
6565
.allowSaveCardFeature(boolean)
6666
.setMeta(List<Meta>)
6767
.withTheme(styleId)
68+
.isPreAuth(boolean)
6869
.setSubAccounts(List<SubAccount>)
69-
.setIsPreAuth(boolean)
7070
.initialize();
7171

7272
| function | parameter | type | required |
@@ -78,25 +78,21 @@ Set the public key, private key and other required parameters. The `RavePayManag
7878
| setlName(lName) | This is the last name of the card holder or the customer | `String` | Required
7979
| setEmail(email) | This is the email address of the customer | `String` | Required
8080
| setNarration(narration) | This is a custom description added by the merchant | `String` | Not Required
81-
| setPublicKey(publicKey) | Merchant's public key | `String` | Required
82-
| setSecretKey(secretKey) | Merchant's secret key | `String` | Required
81+
| setPublicKey(publicKey) | Merchant's public key. | `String` | Required
82+
| setEncryptionKey(encryptionKey) | Merchant's encryption key | `String` | Required
8383
| 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
8484
| acceptAccountPayments(boolean) | Set to `true` if you want to accept payments via cards, else set to `false`. | `boolean` | Not Required
8585
| acceptCardPayments(boolean) | Set to `true` if you want to accept payments via bank accounts, else set to `false` | `boolean` | Not Required |
8686
| acceptMpesaPayments(boolean) | Set to `true` if you want to accept Mpesa payments, else set to `false` . For this option to work, you should set your country to `KE` and your currency to `KES` | `boolean` | Not Required |
8787
| acceptGHMobileMoneyPayments(boolean) | Set to `true` if you want to accept Ghana mobile money payments, else set to `false` . For this option to work, you should set your country to `GH` and your currency to `GHS`| `boolean` | Not Required |
8888
| 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
89-
| allowSaveCardFeature(boolean) | Set to `true` if you want your users to be able to save their cards for later reuse otherwise set to `false` | `boolean` | Required
9089
| 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
91-
|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 `SubAccout` 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
90+
| 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 `SubAccout` 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
9291
| 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
93-
| withTheme(styleId) | Sets the theme of the UI. | `boolean` | Not Required
92+
| withTheme(styleId) | Sets the theme of the UI. | `int` | Not Required
9493
| 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
9594
| initialize() | Launch the Rave Payment UI | N/A | Required
9695

97-
> **SECURITY ALERT**
98-
> You should never store your **SECRET KEY** on the user's device
99-
10096
### 2. Handle the response
10197
In the calling activity, override the `onActivityResult` method to receive the payment response as shown below
10298

@@ -139,7 +135,6 @@ You can apply a new look by changing the color of certain parts of the UI to hig
139135
To configure Proguard, add the following lines to your proguard configuration file. These will keep files related to this sdk
140136
```
141137
keepclasseswithmembers public class com.flutterwave.raveandroid.** { *; }
142-
143138
dontwarn com.flutterwave.raveandroid.card.CardFragment
144139
```
145140

0 commit comments

Comments
 (0)