> ## Documentation Index
> Fetch the complete documentation index at: https://flutterwaveinc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# React Native Flutterwave SDK
Easily implement Flutterwave for payments in your React Native appliction. This library supports both Android and iOS, and use the Flutterwave's V3 API.
## Table Of Content
* Getting Started
* [V2 API](#warning-if-using-version-2-api-warning)
* [Installation](#installation)
* [Dependencies](#dependencies)
* [Activity Indicator (Android)](#activity-indicator-only-needed-for-android)
* [Merchant Public Key](#fire-merchant-public-key-fire)
* [Important Information](#fire-important-information-fire)
* Usage
* [PayWithFlutterwave ](#flutterwave-button)
* [PayWithFlutterwave (with custom render)](#flutterwave-button-with-custom-render)
* [FlutterwaveButton (Flutterwave styled button)](#flutterwavebutton-flutterwave-styled-button)
* [FlutterwaveInit](#flutterwaveinit)
* [Aborting Payment Initialization](#aborting-payment-initialization)
* Props
* [FlutterwaveInitOptions](#flutterwaveinitoptions)
* [PayWithFlutterwaveProps](#flutterwavebuttonprops)
* [FlutterwaveButtonProps](#flutterwavebutton-props)
* Types
* [PayWithFlutterwaveProps](#paywithflutterwaveprops-interface)
* [FlutterwaveButtonProps](#flutterwavebuttonprops-interface)
* [FlutterwaveInitCustomer](#flutterwaveinitcustomer)
* [FlutterwaveInitCustomization](#flutterwaveinitcustomization)
* [FlutterwaveInitSubAccount](#flutterwaveinitsubaccount)
* [FlutterwaveInitOptions](#flutterwaveinitoptions-interface)
* [FlutterwaveInitError](#flutterwaveiniterror)
* [FlutterwavePaymentMeta](#flutterwavepaymentmeta)
* [RedirectParams](#redirectparams)
* [CustomButtonProps](#custombuttonprops)
* [Contributing](./CONTRIBUTING.md)
## What's Inside?
* Pay with Flutterwave button and checkout dialog.
* Standard payment initialization function.
* Flutterwave designed button.
## :warning: If Using Version 2 API :warning:
This version of the library's docs focuses on use cases with the Version 3 of Flutterwaves API, if you are still using the Version 2 API please use [this documentation](./README.v2.md) instead.
## Installation
This library is available on npm, you can install it by running `npm install --save flutterwave-react-native` or `yarn add flutterwave-react-native`
### Dependencies
In order to render the Flutterwave checkout screen this library depends on [react-native-webview](https://github.com/react-native-community/react-native-webview) ensure you properly install this library before continuing.
### Activity Indicator (only needed for android)
To display the Flutterwave styled activity indicator when the checkout screen is being loaded on Android you will need to add some modules in `android/app/build.gradle`.
***Skip this if you already have setup your app to support gif images.***
```javascript theme={null}
dependencies {
// If your app supports Android versions before Ice Cream Sandwich (API level 14)
implementation 'com.facebook.fresco:animated-base-support:1.3.0'
// For animated GIF support
implementation 'com.facebook.fresco:animated-gif:2.0.0'
}
```
### :fire: MERCHANT PUBLIC KEY :fire:
In order to use this library you are required to use your merchant public key and not the secret key. See how to get your API Keys [here](/authentication#get-your-api-keys)
### :fire: IMPORTANT INFORMATION :fire:
If the `options` property on [PayWithFlutterwave](#paywithflutterwaveprops-interface) changes, when next the user taps on the button a new payment will be initialized whether the last one was successful or not.
Remember you cannot use the same transaction reference for two different payments, also remember to recreate the transaction reference before allowing the user initiate a new payment.
## Usage
Below are a few examples showcasing how you can use the library to implement payment in your React Native app.
### PayWithFlutterwave
[View All Props](#flutterwavebuttonprops)
Import `PayWithFlutterwave` from `flutterwave-react-native` and use it like so.
```tsx theme={null}
import {PayWithFlutterwave} from 'flutterwave-react-native';
// or import PayWithFlutterwave from 'flutterwave-react-native';
interface RedirectParams {
status: 'successful' | 'cancelled';
transaction_id?: string;
tx_ref: string;
}
/* An example function called when transaction is completed successfully or canceled */
const handleOnRedirect = (data: RedirectParams) => {
console.log(data);
};
/* An example function to generate a random transaction reference */
const generateTransactionRef = (length: number) => {
var result = '';
var characters =
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
var charactersLength = characters.length;
for (var i = 0; i < length; i++) {
result += characters.charAt(Math.floor(Math.random() * charactersLength));
}
return `flw_tx_ref_${result}`;
};
```
### PayWithFlutterwave (with custom render)
[View All Props](#flutterwavebuttonprops)
Import `PayWithFlutterwave` from `flutterwave-react-native` and use it like so.
```tsx theme={null}
import {PayWithFlutterwave} from 'flutterwave-react-native';
// or import PayWithFlutterwave from 'flutterwave-react-native';
interface RedirectParams {
status: 'successful' | 'cancelled';
transaction_id?: string;
tx_ref: string;
}
/* An example function called when transaction is completed successfully or canceled */
const handleOnRedirect = (data: RedirectParams) => {
console.log(data);
};
(
Pay $500
)}
/>
```
### FlutterwaveButton (Flutterwave styled button)
[View All Props](#flutterwavebuttonprops)
Import `FlutterwaveButton` from `flutterwave-react-native` and use it like so.
```jsx theme={null}
import { FlutterwaveButton } from 'flutterwave-react-native';
Pay $500
;
```
### FlutterwaveInit
When called, this function returns a Promise which resolves to a string on success and rejects if an error occurs. [See all config options](#flutterwaveinitoptions)
Import `FlutterwaveInit` from `flutterwave-react-native` and use it like so.
```javascript theme={null}
import { FlutterwaveInit } from 'flutterwave-react-native';
try {
// initialize payment
const paymentLink = await FlutterwaveInit({
tx_ref: generateTransactionRef(),
authorization: '[your merchant public Key]',
amount: 100,
currency: 'USD',
customer: {
email: 'customer-email@example.com',
},
payment_options: 'card',
});
// use payment link
usePaymentLink(paymentLink);
} catch (error) {
// handle payment error
displayError(error.message);
}
```
### Aborting Payment Initialization
:wave: Hi, so there are cases where you have already initialized a payment with `FlutterwaveInit` but might also want to be able to cancel the payment initialization should in case your component is being unmounted or you want to allow users cancel the action before the payment is initialized, we have provided a way for you to do this... [continue reading](./docs/AbortingPaymentInitialization.md)
## Props
### FlutterwaveInitOptions
[See Interface](#flutterwaveinitoptions-interface)
| Name | Required | Type | Default | Description |
| ---------------- | -------- | ---------------------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| authorization | Yes | string | **REQUIRED** | Your merchant public key, see how to get your [API Keys](/authentication#get-your-api-keys) |
| tx\_ref | Yes | string | **REQUIRED** | Your transaction reference. This MUST be unique for every transaction. |
| amount | Yes | string | **REQUIRED** | Amount to charge the customer. |
| currency | No | string | NGN | Currency to charge in. Defaults to NGN. [See accepted currencies here](https://support.flutterwave.com/en/articles/3632719-accepted-currencies) |
| integrity\_hash | No | string | undefined | This is a sha256 hash of your FlutterwaveCheckout values, it is used for passing secured values to the payment gateway. |
| payment\_options | Yes | string | **REQUIRED** | This specifies the payment options to be displayed e.g - card, mobilemoney, ussd and so on. |
| payment\_plan | No | number | undefined | This is the payment plan ID used for [Recurring billing](/other-features/recurring-payments/introduction). |
| redirect\_url | Yes | string | **REQUIRED** | 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. **IMPORTANT** This only required when you are directly using [FlutterwaveInit](#flutterwave-standard-init) |
| customer | Yes | [FlutterwaveInitCustomer](#flutterwaveinitcustomer) | **REQUIRED** | This is an object that contains your customer details. `E.g.'customer': { 'email': 'example@example.com', 'phonenumber': '08012345678', 'name': 'Takeshi Kovacs' }.` |
| subaccounts | No | array of [FlutterwaveInitSubAccount](#flutterwaveinitsubaccount) | undefined | This is an array of objects containing the subaccount IDs to split the payment into. Check out the [Split Payment page](/other-features/split-payments) for more info |
| meta | No | [FlutterwavePaymentMeta](#flutterwavepaymentmeta) | undefined | This is an object that helps you include additional payment information to your request. `E.g. { 'consumer_id': 23, 'consumer_mac': '92a3-912ba-1192a' }` |
| customizations | No | [FlutterwaveInitCustomizations](#flutterwaveinitcustomizations) | undefined | 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'}` |
### PayWithFlutterwaveProps
[See Interface](#paywithflutterwaveprops-interface)
| Name | Required | Type | Default | Description |
| ----------------- | -------- | ------------------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| style | No | object | undefined | Used to apply styling to the button. |
| onRedirect | Yes | function | **REQUIRED** | Called when a payment is completed successfully or is canceled. The function will receive [redirect params](#redirectparams) as an argument. |
| onWillInitialize | No | function | undefined | This will be called before a payment link is generated. |
| onDidInitialize | No | function | undefined | This is called when a new payment link has been successfully initialized. |
| onInitializeError | No | function | undefined | This is called if an error occurred while initializing a new pyment link. The function will receive [FlutterwaveInitError](#flutterwaveiniterror) |
| onAbort | No | function | undefined | This is called if a user aborts a transaction, a user can abort a transaction when they click on the dialog's backdrop and choose cancel when prompted to cancel transaction. |
| options | Yes | [FlutterwaveInitOptions](#flutterwaveinitoptions) | **REQUIRED** | The option passed here is used to initialize a payment. |
| customButton | No | function | undefined | This is used to render a custom button. The function a prop argument structured like [CustomButtonProps](#custombuttonprops), this function should return a valid React node. |
| alignLeft | No | boolean | undefined | This aligns the content of the button to the left. |
### FlutterwaveButton Props
[See Interface](#flutterwavebuttonprops-interface)
| Name | Required | Type | Default | Description |
| --------- | -------- | --------- | --------- | --------------------------------------------------------------------------------------------------------- |
| style | No | ViewStyle | undefined | This component uses the same style properties that are applicable to react-native's View component style. |
| onPress | Yes | function | undefined | This property receive a function that is called on button press. |
| disabled | No | boolean | undefined | This disables button, and causes onPress not to be fired. |
| alignLeft | No | boolean | undefined | This aligns the content of the button to the left. |
## Types
#### CustomButtonProps
```typescript theme={null}
interface CustomButtonProps {
disabled: boolean;
isInitializing: boolean;
onPress: () => void;
}
```
#### RedirectParams
```typescript theme={null}
interface RedirectParams {
status: 'successful' | 'cancelled';
transaction_id?: string;
tx_ref: string;
}
```
#### FlutterwaveInitError
```typescript theme={null}
interface FlutterwaveInitError {
code: string;
message: string;
errorId?: string;
errors?: Array;
}
```
#### FlutterwavePaymentMeta
```typescript theme={null}
interface FlutterwavePaymentMeta {
[k: string]: any;
}
```
### FlutterwaveInitCustomer
```typescript theme={null}
interface FlutterwaveInitCustomer {
email: string;
phonenumber?: string;
name?: string;
}
```
### FlutterwaveInitCustomizations
```typescript theme={null}
interface FlutterwaveInitCustomizations {
title?: string;
logo?: string;
description?: string;
}
```
### FlutterwaveInitSubAccount
```typescript theme={null}
interface FlutterwaveInitSubAccount {
id: string;
transaction_split_ratio?: number;
transaction_charge_type?: string;
transaction_charge?: number;
}
```
#### FlutterwaveInitOptions Interface
```typescript theme={null}
export interface FlutterwaveInitOptions {
authorization: string;
tx_ref: string;
amount: number;
currency: string;
integrity_hash?: string;
payment_options?: string;
payment_plan?: number;
redirect_url: string;
customer: FlutterwaveInitCustomer;
subaccounts?: Array;
meta?: FlutterwavePaymentMeta;
customizations?: FlutterwaveInitCustomizations;
}
```
#### PayWithFlutterwaveProps Interface
```typescript theme={null}
interface PayWithFlutterwaveProps {
style?: ViewStyle;
onRedirect: (data: RedirectParams) => void;
onWillInitialize?: () => void;
onDidInitialize?: () => void;
onInitializeError?: (error: FlutterwaveInitError) => void;
onAbort?: () => void;
options: Omit;
customButton?: (props: CustomButtonProps) => React.ReactNode;
alignLeft?: 'alignLeft' | boolean;
}
```
#### FlutterwaveButtonProps Interface
```typescript theme={null}
interface FlutterwaveButtonProps {
style?: StyleProp;
disabled?: boolean;
alignLeft?: boolean;
onPress?: () => void;
}
```