Skip to content

Commit 71c9487

Browse files
committed
tag required fields in the readme
1 parent e67d55a commit 71c9487

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,20 +58,20 @@ Set the public key, private key and other required parameters. The `RavePayManag
5858
.setMeta(List<Meta>)
5959
.withTheme(styleId)
6060
.initialize();
61-
* `setAmount()` - This is the amount to be charged from card/account. `double`
62-
* `setCountry()` - This is the route country for the transaction with respect to the currency. `String`
63-
* `setCurrency` - This is the specified currency to charge the card in. `String`
64-
* `setEmail()` - This is the email address of the customer. `String`
65-
* `setfName()` - This is the first name of the card holder or the customer. `String`
66-
* `setlName()` - This is the last name of the card holder or the customer. `String`
61+
* `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
62+
* `setCountry()` - This is the route country for the transaction with respect to the currency. `String` - `[Required]`
63+
* `setCurrency` - This is the specified currency to charge the card in. `String` - `[Required]`
64+
* `setEmail()` - This is the email address of the customer. `String` - `[Required]`
65+
* `setfName()` - This is the first name of the card holder or the customer. `String` - `[Required]`
66+
* `setlName()` - This is the last name of the card holder or the customer. `String` - `[Required]`
6767
* `setNarration()` - This is a custom description added by the merchant. `String`
68-
* `setPublicKey()` - Merchant's public key `String`
69-
* `setSecretKey()` - Merchant's secret key `String`
70-
* `setTxRef()` - This is the unique reference, unique to the particular transaction being carried out. It is generated by the merchant for every transaction `String`
68+
* `setPublicKey()` - Merchant's public key `String` - `[Required]`
69+
* `setSecretKey()` - Merchant's secret key `String` - `[Required]`
70+
* `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]`
7171
* `acceptAccountPayments()` - Set to `true` if you want to accept payments via bank accounts, else set to false. `boolean`. Defaults to `true`
7272
* `acceptCardPayments()` - Set to `true` if you want to accept payments via cards, else set to `false`. `boolean`. Defaults to `true`
7373
* `onStagingEnv()` - Set to `true` if you want your transactions to run in the staging environment otherwise set to `false`. Defaults to `false`
74-
* `allowSaveCardFeature` - Set to `true` if you want your users to be able to save their cards for later reuse otherwise set to `false`.
74+
* `allowSaveCardFeature` - Set to `true` if you want your users to be able to save their cards for later reuse otherwise set to `false`. - `[Required]`
7575
* `setMeta()` - Pass in any other custom data you wish to pass. It takes in a `List` of `Meta` objects
7676
* `withTheme()` - Sets the theme of the UI. `int`
7777
* `initialize` - Launch the Rave Payment UI

0 commit comments

Comments
 (0)