Skip to content

Commit 63345ad

Browse files
committed
change param list to table for easier access
1 parent 8173873 commit 63345ad

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -64,23 +64,26 @@ Set the public key, private key and other required parameters. The `RavePayManag
6464
.setMeta(List<Meta>)
6565
.withTheme(styleId)
6666
.initialize();
67-
* `setAmount()` - This is the amount to be charged from card/account. `double` - `[Required]`. If `amount` is not specified, the user is presented with a field in the UI to enter the amount. However if specified, the amount field is hidden
68-
* `setCountry()` - This is the route country for the transaction with respect to the currency. `String` - `[Required]`. You can find a list of supported countries and currencies [here](https://flutterwavedevelopers.readme.io/docs/multicurrency-payments)
69-
* `setCurrency` - This is the specified currency to charge the card in. `String` - `[Required]`.
70-
* `setEmail()` - This is the email address of the customer. `String` - `[Required]`
71-
* `setfName()` - This is the first name of the card holder or the customer. `String` - `[Required]`
72-
* `setlName()` - This is the last name of the card holder or the customer. `String` - `[Required]`
73-
* `setNarration()` - This is a custom description added by the merchant. `String`
74-
* `setPublicKey()` - Merchant's public key `String` - `[Required]`
75-
* `setSecretKey()` - Merchant's secret key `String` - `[Required]`
76-
* `setTxRef()` - This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction `String` - `[Required]`
77-
* `acceptAccountPayments()` - Set to `true` if you want to accept payments via bank accounts, else set to false. `boolean`. Defaults to `true`
78-
* `acceptCardPayments()` - Set to `true` if you want to accept payments via cards, else set to `false`. `boolean`. Defaults to `true`
79-
* `onStagingEnv()` - Set to `true` if you want your transactions to run in the staging environment otherwise set to `false`. Defaults to `false`
80-
* `allowSaveCardFeature` - Set to `true` if you want your users to be able to save their cards for later reuse otherwise set to `false`. - `[Required]`
81-
* `setMeta()` - Pass in any other custom data you wish to pass. It takes in a `List` of `Meta` objects
82-
* `withTheme()` - Sets the theme of the UI. `int`
83-
* `initialize` - Launch the Rave Payment UI
67+
68+
| function | parameter | type | required |
69+
| ------------- |:-------------:| -----:| -----:|
70+
| setAmount(amount) | This is the amount to be charged from card/account | `double` | Required
71+
| setCountry(country) | This is the route country for the transaction with respect to the currency. You can find a list of supported countries and currencies [here](https://flutterwavedevelopers.readme.io/docs/multicurrency-payments) | `String` | Required
72+
| setCurrency(currency) | This is the specified currency to charge the card in | `String` | Required
73+
| setfName(fName) | This is the first name of the card holder or the customer | `String` | Required
74+
| setlName(lName) | This is the last name of the card holder or the customer | `String` | Required
75+
| setEmail(email) | This is the email address of the customer | `String` | Required
76+
| setNarration(narration) | This is a custom description added by the merchant | `String` | Not Required
77+
| setPublicKey(publicKey) | Merchant's public key | `String` | Required
78+
| setSecretKey(secretKey) | Merchant's secret key | `String` | Required
79+
| 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
80+
| acceptAccountPayments(boolean) | Set to `true` if you want to accept payments via cards, else set to `false`. | `boolean` | Not Required
81+
| acceptCardPayments(boolean) | Set to `true` if you want to accept payments via bank accounts, else set to `false` | `boolean` | Not Required |
82+
| 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
83+
| 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
84+
| 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
85+
| withTheme(styleId) | Sets the theme of the UI. | `int` | Not Required
86+
| initialize() | Launch the Rave Payment UI | N/A | Required
8487

8588
> **SECURITY ALERT**
8689
> You should never store your **SECRET KEY** on the user's device

0 commit comments

Comments
 (0)