Skip to content

Commit b6d4293

Browse files
Angello-droidAngello-droid
authored
Update README.md
1 parent a6a7803 commit b6d4293

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

‎README.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## Introduction
1111

12-
The Angular SDK helps you create seamless payment experiences in your Angular mobile or web app. By connecting to our modal, you can start collecting payment in no time.
12+
The Angular SDK helps you create seamless payment experiences in your Angular mobile or web app. By connecting to our modal, you can start collecting payments in no time.
1313

1414
Available features include:
1515

@@ -30,8 +30,8 @@ Available features include:
3030

3131
## Requirements
3232

33-
1. Flutterwave version 3 API keys
34-
2. Node version >= 14.15.0 and npm >= 6.14.8
33+
1. Flutterwave version 3 [API keys](https://developer.flutterwave.com/v3.0.0/docs/authentication).
34+
2. Node version >= 14.15.0 and npm >= 6.14.8.
3535
3. Angular version >= 18.
3636

3737
## Installation
@@ -64,14 +64,14 @@ import { FlutterwaveModule } from "flutterwave-angular-v3"
6464
})
6565
```
6666

67-
> NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
67+
> NB: If you experience compilation errors in your app after importing the Flutterwave module, component, or service.
6868
Kindly include the following line in tsconfig.app.json under `compilerOptions` :
6969

7070
```
7171
paths": { "@angular/*": [ "node_modules/@angular/*" ] }
7272
```
7373

74-
Then restart server and try again
74+
Then restart the server and try again
7575

7676
## Usage
7777

@@ -150,7 +150,7 @@ export class AppComponent {
150150

151151
#### Method 2
152152

153-
Pass in the payment parameters as an object to the component `data` attribute.
153+
Pass in the payment parameters as an object to the component's `data` attribute.
154154

155155
```typescript
156156
import { Component, OnInit } from "@angular/core";
@@ -264,7 +264,7 @@ export class AppComponent {
264264
onclose: this.closedPaymentModal,
265265
callbackContext: this,
266266
};
267-
//Inject the flutterwave service
267+
//Inject the Flutterwave service
268268
constructor(private flutterwaveService: FlutterwaveService) {}
269269
makePayment() {
270270
this.flutterwaveService.inlinePay(this.paymentData);
@@ -335,7 +335,7 @@ export class AppComponent {
335335

336336
### Recurring Payments
337337

338-
Pass the payment plan ID into your payload to make [recurring payments](https://developer.flutterwave.com/docs/recurring-payments/payment-plans).
338+
Pass the payment plan ID into your payload to make [recurring payments](https://developer.flutterwave.com/v3.0.0/docs/payment-plans-1).
339339

340340
```typescript
341341
import { Component, OnInit } from "@angular/core";
@@ -400,54 +400,54 @@ export class AppComponent {
400400

401401
### Parameters
402402

403-
Read more about our parameters and how they can be used [here](https://developer.flutterwave.com/docs/collecting-payments/inline).
403+
Read more about our parameters and how they can be used [here](https://developer.flutterwave.com/v3.0.0/docs/inline).
404404

405-
| Parameter | Always Required ? | Description |
405+
| Parameter | Always Required? | Description |
406406
| ------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
407407
| public_key | True | Your API public key |
408408
| tx_ref | True | Your transaction reference. This MUST be unique for every transaction |
409409
| amount | True | Amount to charge the customer. |
410410
| currency | False | currency to charge in. Defaults to NGN |
411-
| integrity_hash | False | This is a sha256 hash of your FlutterwaveCheckout values, it is used for passing secured values to the payment gateway. |
412-
| payment_options | True | This specifies the payment options to be displayed e.g - card, mobilemoney, ussd and so on. |
411+
| integrity_hash | False | This is a sha256 hash of your FlutterwaveCheckout values. It is used for passing secured values to the payment gateway. |
412+
| payment_options | True | This specifies the payment options to be displayed e.g - card, mobilemoney, ussd, and so on. |
413413
| payment_plan | False | This is the payment plan ID used for Recurring billing |
414-
| redirect_url | False | URL to redirect to when a transaction is completed. This is useful for 3DSecure payments so we can redirect your customer back to a custom page you want to show them. |
415-
| customer | True | This is an object that can contains your customer details: e.g - 'customer': {'email': 'example@example.com','phonenumber': '08012345678','name': 'Takeshi Kovacs' } |
416-
| subaccounts | False | This is an array of objects containing the subaccount IDs to split the payment into. Check our Split Payment page for more info |
417-
| meta | False | This is an object that helps you include additional payment information to your request e.g {'consumer_id': 23,'consumer_mac': '92a3-912ba-1192a' } |
418-
| customizations | True | This is an object that contains title, logo, and description you want to display on the modal e.g{'title': 'Pied Piper Payments','description': 'Middleout isn't free. Pay the price','logo': 'https://assets.piedpiper.com/logo.png' } |
419-
| callback (function) | False | This is the function that runs after payment is completed |
420-
| close (function) | False | This is the function that runs after payment modal is closed |
414+
| redirect_url | False | URL to redirect to when a transaction is completed. This is useful for 3DSecure payments, so we can redirect your customer back to a custom page you want to show them. |
415+
| customer | True | This is an object that can contain your customer details: e.g, 'customer': {'email': 'example@example.com', 'phonenumber': '08012345678', 'name': 'Takeshi Kovacs' } |
416+
| subaccounts | False | This is an array of objects containing the subaccount IDs to split the payment into. Check our [Split Payment page](https://developer.flutterwave.com/v3.0.0/docs/split-payments) for more info. |
417+
| meta | False | This is an object that helps you include additional payment information to your request, e.g, {'consumer_id': 23, 'consumer_mac': '92a3-912ba-1192a' } |
418+
| customizations | True | This is an object that contains title, logo, and description you want to display on the modal e.g, {'title': 'Pied Piper Payments', 'description': 'Middleout isn't free. Pay the price', 'logo': 'https://assets.piedpiper.com/logo.png' } |
419+
| callback (function) | False | This is the function that runs after payment is completed. |
420+
| close (function) | False | This is the function that runs after the payment modal is closed. |
421421

422422
### Methods
423423

424424
Methods provided by FlutterwaveService and descriptions:
425425

426426
| Method Name | Parameters | Returns | Description |
427427
| ----------------- | --------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
428-
| inlinePay | InlinePaymentOptions : Object | Null | This methods allows you to setup and open the payment modal via code |
429-
| asyncInlinePay | AsyncPaymentOptions : Object | Promise | This methods allows you to setup and open the payment modal via code and returns a promise containing the payment response |
430-
| closePaymentModal | waitDuration : number (Optional, default = 0) | Null | This methods allows you to close the payment modal via code. You can setup the wait time before modal close |
428+
| inlinePay | InlinePaymentOptions: Object | Null | This method allows you to set up and open the payment modal via code |
429+
| asyncInlinePay | AsyncPaymentOptions: Object | Promise | This method allows you to set up and open the payment modal via code and returns a promise containing the payment response |
430+
| closePaymentModal | waitDuration: number (Optional, default = 0) | Null | This method allows you to close the payment modal via code. You can set up the wait time before the modal closes. |
431431

432432

433433
## Debugging Errors
434434

435-
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).
435+
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).
436436

437437
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.
438438

439-
NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
439+
NB: If you experience compilation errors in your app after importing the Flutterwave module, component, or service.
440440
Kindly include the following line in tsconfig.app.json under `compilerOptions` :
441441

442442
```
443443
paths": { "@angular/*": [ "node_modules/@angular/*" ] }
444444
```
445445

446-
Then restart server and try again
446+
Then restart the server and try again
447447

448448
# Support
449449

450-
For additional assistance using this library, please create an issue on the Github repo or contact the developer experience (DX) team via [email](mailto:developers@flutterwavego.com) or on [slack](https://bit.ly/34Vkzcg).
450+
For additional assistance using this library, please create an issue on the GitHub repo or contact the developer experience (DX) team via [email](mailto:developers@flutterwavego.com) or on [slack](https://bit.ly/34Vkzcg).
451451

452452
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
453453

0 commit comments

Comments
 (0)