react-ravepayment
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.1 • Public • Published

    react-ravepayment

    A React library wrapper for implementing ReavePay Payment Gateway

    Demo

    Alt text

    Installation

    npm install react-ravepayment --save

    or

    yarn add react-ravepayment --save

    Usage

    Hooks

    import React, { Component } from "react";
    import { useRavePayment } from "react-ravepayment";
     
    const config = {
      txref: "rave-123456",
      customer_email: "user@example.com",
      customer_phone: "234099940409",
      amount: 2000,
      PBFPubKey: "FLWPUBK-XXXXXXXXXXXXXXXXXXXXXXXXXX-X",
      production: false,
    };
     
    const App = () => {
      const { initializePayment } = useRavePayment(config);
      return (
        <div>
          <button onClick={() => initializePayment()}>Pay 2000</button>
        </div>
      );
    };
     
    export default App;

    Components

    import React, { Component } from "react";
    import { RaveProvider, RavePaymentButton } from "react-ravepayment";
     
    const config = {
      txref: "rave-123456",
      customer_email: "user@example.com",
      customer_phone: "234099940409",
      amount: 2000,
      PBFPubKey: "FLWPUBK-XXXXXXXXXXXXXXXXXXXXXXXXXX-X",
      production: false,
      onSuccess: () => {},
      onClose: () => {}
    };
     
    const App = () => {
      return (
        <div>
          <RaveProvider {...config}>
            <RavePaymentButton>Pay 2000</RavePaymentButton>
          </RaveProvider>
        </div>
      );
    };
     
    export default App;

    For more usage example check

    API

    See the API reference.

    Deployment

    WHEN DEPLOYING TO PRODUCTION/LIVE SYSTEM, take note of the following;

    1. Change isProduction attribute in the component tag to true i.e isProduction={true}
    2. Change RavePay PUBLIC KEY
    3. Ensure you implement webhooks to receive automatic updates when a transaction happens.

    Contribution

    1. Fork it!
    2. Create your feature branch: git checkout -b feature-name
    3. Commit your changes: git commit -am 'Some commit message'
    4. Push to the branch: git push origin feature-name
    5. Submit a pull request 😉😉

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Issues

    Looking to contribute? Look for the Good First Issue label.

    🐛 Bugs

    Please file an issue for bugs, missing documentation, or unexpected behavior.

    License

    MIT

    Install

    npm i react-ravepayment

    DownloadsWeekly Downloads

    239

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    76.8 kB

    Total Files

    23

    Last publish

    Collaborators

    • iamraphson