Spotflow React Library

Introduction

The Spotflow React SDK helps you or rather enables users to make payments seamlessly. It integrates smoothly into your application, providing a streamlined checkout experience.

Available Features:

• Collections: Card, Bank Transfers, USSD
• Recurring payments: Tokenization and Subscriptions.

Table of Contents

1. Requirements
2. Installation
3. Usage
4. Support
5. License
6. Contributing Guidelines
7. Contributors

Requirements

1. Spoflow Encryption keys
2. Spotflow API keys
3. Node versions >= 16.x.x npm >=7.x.x
4. React version >= 16.8.0

Demo

Installation

using npm

 npm i @spot-flow/react-spotflow-checkout

# or

 yarn add @spot-flow/react-spotflow-checkout

# or
 pnpm add @spot-flow/react-spotflow-checkout

Usage

Add Spotflow as a component or React Hook

This library can be implemented using the following

1. By Using the SpotflowButton component
2. By Using Hooks (preferred method)

1. Using the Payment CheckoutButton

import React from "react";
import { SpotflowButton } from "@spot-flow/react-spotflow-checkout";

const PaymentComponent = () => {
  return (
    <div>
      <SpotflowButton
        amount={4000} // Not required for subscription payment
        currency="NGN"
        email="[email protected]"
        firstname="John"
        lastname="Doe"
        phone="09090909090"
        encryptionKey="SKKXXXXXXXXXXXXXXXXX"
        planId="9e0808304-344d-XXXXXXXXX-XXXXX834034" // Not required for a one time payment
        merchantKey="sk_test_fXXXXedhXXXXXXXXXXXXXXXX"
        text="Pay Money"
      />
    </div>
  );
};

SpotflowButton has the ButtonProps which can allow you to customize to your design

2. Using Hooks

import React from "react";
import { useSpotflowPayment } from "@spot-flow/react-spotflow-checkout";

const PaymentComponent = () => {
  const config = {
    amount: 4000, // Not required for subscription payment
    currency: "NGN",
    email: "[email protected]",
    merchantKey: "sk_test_fXXXXedhXXXXXXXXXXXXXXXX",
    planId: "9e0808304-344d-XXXXXXXXX-XXXXX834034", // Not required for a one time payment
    encryptionKey:"SKKXXXXXXXXXXXXXXXXX"
  }
  const initialFn = useSpotflowPayment(config);

  return (
    <div>
      <button
        type="button"
        onClick={() => {
          initialFn({
            config: undefined,
            onClose: () => {
               // Enter your action here
            },
            onSuccess: () => {
               // Enter your action here 
            }
          });
        }}
        className=" bg-primary-main text-black"
      >
        Pay
      </button>
    </div>
  );
};

Parameters

Read more about our parameters and how they can be used here.

Parameter	Required	Description
merchantKey	True	Your API Secret
reference	False	Your transaction reference. This MUST be unique for every transaction
amount	False	Amount to charge the customer. NB: this most likely comes from the plan details. This is not required for subscription payments.
currency	True	Currency to charge in.
localCurrency	False	This is only required when a payment is being made in USD
encryptionKey	True	This is the encryption key for the merchant. This is required for card payments.
planId	False	This is the plan ID being paid for however, this is not required for one time payments.
firstName	False	This is the Customer's First Name
lastName	False	This is the Customer's Last Name
phone	False	This is the Customer's Phone Number
email	True	This is the Customer's Email Address
metadata	True	This contains other information about the product such as the product name and other additional properties. Product Name should not be passed if planId is being passed
callBackUrl	False	This is the URL the browser redirects to on success of a payment

Contribution Guidelines

We welcome contributions from the community. Read more about our community contribution guidelines here.

License

By contributing to this library, you agree that your contributions will be licensed under its MIT license.

Copyright (c) Spotflow Inc.