Skip to main content

Documentation Index

Fetch the complete documentation index at: https://flutterwaveinc.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Concept

This guide will walk you through integrating Flutterwave into your React application using React hooks. You’ll learn how to:
  1. Set up your React app: Install the packages and configure your app to handle payments using React hooks.
  2. Create payment configuration: Define your payment settings, including transaction reference, amount, currency, and customer details.
  3. Handle the payment logic: Use the useFlutterwave hook to initialize and handle the payment process in your React app.

​
Step 1: Set up your React App

To get started, create a new react project and change into the directory using the following command: 
npx create-react-app flutterwave-react-app
cd flutterwave-react-app

​
Install the Dependencies

Run the command below to install the required dependencies: 
npm install flutterwave-react-v3

​
Step 2: Add Payment Configuration

You’ll need a page to show your customers’ orders. Create a src/PrePayment.js file to render the payment details before processing the payment.

​
Initialize the PrePayment Function

Create a PrePayment function, import the required dependencies, and add data to simulate a real-life scenario. 
import React, { useState } from 'react';
import { FlutterWaveButton, closePaymentModal } from 'flutterwave-react-v3';
import './App.css'; // Import the CSS file
export default function PrePayment({ onSuccess }) {
	const userDetails = {
		name: 'Kelvin Joe Young',
		email: 'user@gmail.com',
		phonenumber: '07000001100',
		address: '123 Street Name, City, Country',
		delivery: 'Home Delivery',
	};
	// Dummy items in the cart
	const items = [
		{ id: 1, name: 'Wireless Mouse', price: 5000 },
		{ id: 2, name: 'Bluetooth Speaker', price: 12000 },
		{ id: 3, name: 'Smartwatch', price: 25000 },
	];

	// Calculate total amount
	const totalAmount = items.reduce((sum, item) => sum + item.price, 0);

	// Payment state
	const [paymentCompleted, setPaymentCompleted] = useState(false);
	const [paymentResponse, setPaymentResponse] = useState(null);
}

​
Define Payment Configuration

Set up the configuration object for the payment. This includes your Flutterwave public key, customer details, payment amount, and payment options. 
export default function PrePayment({ onSuccess }) {
	// Dummy data and Payment state code goes here

	// Flutterwave payment configuration
	const config = {
		public_key: process.env.REACT_APP_FLW_SECRET_KEY,
		tx_ref: Date.now(),
		amount: totalAmount,
		currency: 'NGN',
		payment_options: 'card,mobilemoney,ussd',
		customer: {
			email: userDetails.email,
			phone_number: userDetails.phonenumber,
			name: userDetails.name,
		},
		customizations: {
			title: 'Store Purchase',
			description: 'Payment for items in your cart',
			logo: 'https://example.com/logo.png', // Your store logo
		},
	};

	const fwConfig = {
		...config,
		text: 'Checkout',
		callback: (response) => {
			console.log(response);
			setPaymentCompleted(true); // Set payment as completed
			setPaymentResponse(response); // Store payment response
			onSuccess(response); // Trigger the success handler
			closePaymentModal(); // Close the payment modal
		},
		onClose: () => {
			console.log('Payment modal closed');
		},
	};
}
To get your API key, log into your Flutterwave dashboard and navigate to the API keys section under the Settings menu.

​
Render the Pre-Payment Page

Update the code to render the payment information and a button for the user to initiate payment. 
export default function PrePayment({ onSuccess }) {
	// Flutterwave Configuration Code goes here

	return (
		<div className='container'>
			{paymentCompleted ? (
				// Show receipt after successful payment
				<div className='receipt'>
					<h1>Payment Complete</h1>
					<p>Thank you for your payment, {userDetails.name}!</p>
					<p>Transaction Reference: {paymentResponse?.tx_ref}</p>
					<p>Total Amount Paid: ₦{totalAmount}</p>
					<p>Items Purchased:</p>
					<ul>
						{items.map((item) => (
							<li key={item.id}>
								{item.name}: ₦{item.price}
							</li>
						))}
					</ul>
					<p>
						A receipt has been sent to your email:{' '}
						{userDetails.email}
					</p>
				</div>
			) : (
				// Show order confirmation and payment button before payment
				<>
					<h1>Order Confirmation</h1>
					<div>
						<h3>Items in your cart:</h3>
						<ul>
							{items.map((item) => (
								<li key={item.id}>
									{item.name}: ₦{item.price}
								</li>
							))}
						</ul>
						<h3>Total: ₦{totalAmount}</h3>
					</div>
					<div className='user-info'>
						<h3>User Information</h3>
						<p>Name: {userDetails.name}</p>
						<p>Email: {userDetails.email}</p>
						<p>Phone: {userDetails.phonenumber}</p>
						<p>Address: {userDetails.address}</p>
						<p>Method of delivery: {userDetails.delivery}</p>
					</div>
					{/* Flutterwave payment button */}
					<FlutterWaveButton {...fwConfig} />
				</>
			)}
		</div>
	);
}
Here is how your entire src/PrePayment should look like: 
import React, { useState } from 'react';
import { FlutterWaveButton, closePaymentModal } from 'flutterwave-react-v3';
import './App.css'; // Import the CSS file
export default function PrePayment({ onSuccess }) {
	// Dummy user details
	const userDetails = {
		name: 'Kelvin Joe Young',
		email: 'user@gmail.com',
		phonenumber: '07000001100',
		address: '123 Street Name, City, Country',
		delivery: 'Home Delivery',
	};
	// Dummy items in the cart
	const items = [
		{ id: 1, name: 'Wireless Mouse', price: 5000 },
		{ id: 2, name: 'Bluetooth Speaker', price: 12000 },
		{ id: 3, name: 'Smartwatch', price: 25000 },
	];
	// Calculate total amount
	const totalAmount = items.reduce((sum, item) => sum + item.price, 0);
	// Payment state
	const [paymentCompleted, setPaymentCompleted] = useState(false);
	const [paymentResponse, setPaymentResponse] = useState(null);
	// Flutterwave payment configuration
	const config = {
		public_key: process.env.REACT_APP_FLW_SECRET_KEY,
		tx_ref: Date.now(),
		amount: totalAmount,
		currency: 'NGN',
		payment_options: 'card,mobilemoney,ussd',
		customer: {
			email: userDetails.email,
			phone_number: userDetails.phonenumber,
			name: userDetails.name,
		},
		customizations: {
			title: 'Store Purchase',
			description: 'Payment for items in your cart',
			logo: 'https://example.com/logo.png', // Your store logo
		},
	};
	const fwConfig = {
		...config,
		text: 'Checkout',
		callback: (response) => {
			console.log(response);
			setPaymentCompleted(true); // Set payment as completed
			setPaymentResponse(response); // Store payment response
			onSuccess(response); // Trigger the success handler
			closePaymentModal(); // Close the payment modal
		},
		onClose: () => {
			console.log('Payment modal closed');
		},
	};
	return (
		<div className='container'>
			{paymentCompleted ? (
				// Show receipt after successful payment
				<div className='receipt'>
					<h1>Payment Complete</h1>
					<p>Thank you for your payment, {userDetails.name}!</p>
					<p>Transaction Reference: {paymentResponse?.tx_ref}</p>
					<p>Total Amount Paid: ₦{totalAmount}</p>
					<p>Items Purchased:</p>
					<ul>
						{items.map((item) => (
							<li key={item.id}>
								{item.name}: ₦{item.price}
							</li>
						))}
					</ul>
					<p>
						A receipt has been sent to your email:{' '}
						{userDetails.email}
					</p>
				</div>
			) : (
				// Show order confirmation and payment button before payment
				<>
					<h1>Order Confirmation</h1>
					<div>
						<h3>Items in your cart:</h3>
						<ul>
							{items.map((item) => (
								<li key={item.id}>
									{item.name}: ₦{item.price}
								</li>
							))}
						</ul>
						<h3>Total: ₦{totalAmount}</h3>
					</div>
					<div className='user-info'>
						<h3>User Information</h3>
						<p>Name: {userDetails.name}</p>
						<p>Email: {userDetails.email}</p>
						<p>Phone: {userDetails.phonenumber}</p>
						<p>Address: {userDetails.address}</p>
						<p>Method of delivery: {userDetails.delivery}</p>
					</div>
					{/* Flutterwave payment button */}
					<FlutterWaveButton {...fwConfig} />
				</>
			)}
		</div>
	);
}

​
Step 3: Handle the Payment Logic

Now, you need a component to manage the routing logic and handle success or errors.

​
Add the Payment Success Page (PaymentSuccess.js)

First, you need to create a PaymentSuccess.js file that displays a confirmation message and the details of the payment after it has been completed. 
import React from 'react';
export default function PaymentSuccess({ paymentDetails }) {
	return (
		<div className='payment-success-page'>
			{/* Success icon (use an actual icon, e.g., from FontAwesome) */}
			<div className='success-icon'>✔️</div>
			<h1>Payment Successful!</h1>
			<p>Thank you, {paymentDetails.customer.name}.</p>
			<div className='transaction-details'>
				<p>
					Your payment of{' '}
					<span>
						{paymentDetails.currency} {paymentDetails.amount}
					</span>{' '}
					has been processed successfully.
				</p>
				<p>
					Transaction Reference: <span>{paymentDetails.tx_ref}</span>
				</p>
			</div>
		</div>
	);
}

​
Update the Main Component (App.js)

Next, update your App.js file to manage the payment flow and state. 
import React, { useState } from 'react';
import PrePaymentPage from './PrePayment';
import PaymentSuccess from './PaymentSuccess';
import './App.css';
export default function App() {
	const [paymentSuccess, setPaymentSuccess] = useState(false);
	const [paymentDetails, setPaymentDetails] = useState(null);
	const handleSuccess = (details) => {
		setPaymentSuccess(true); // Mark payment as successful
		setPaymentDetails(details); // Store payment details for success page
	};
	return (
		<div className='App'>
			{!paymentSuccess ? (
				<PrePaymentPage onSuccess={handleSuccess} />
			) : (
				<PaymentSuccess paymentDetails={paymentDetails} />
			)}
		</div>
	);
}

​
Launch your Development Server

Finally, start your React application to see the changes in your browser. 
npm start

​
Next Step

Now that you’ve completed the integration, feel free to explore other Flutterwave features. You can also extend the application by adding custom styles, implementing additional payment options, or incorporating any new features using our React SDK.