react-atlas-pay
Advanced tools
Readme
React Atlas Pay by Raven bank allows you recieve payments and build powerful checkout experience on your react web apps, to use this you will need to create an account on raven atlas, visit, "Raven bank" for more.
npm install react-atlas-pay
or
```bash
yarn add react-atlas-pay
React Atlas Pay Uses normal react Conventions and Exposes for you a useAtlasPay Hook, below is an example usage
import { useEffect, useState } from 'react'
import useAtlasPay from 'react-atlas-pay'
export default function App() {
const [pay, atlasEvent] = useAtlasPay()
// The useAtlasPay hook works similar to react useState, you can call the pay or atlasEvent handler anything you wish
const config = {
customer_email: 'john@example.com',
description: 'test payment',
merchant_ref: 'your_merchant_reference',
amount: 100,
redirect_url: '',
payment_methods: 'card,bank_transfer,ussd,raven',
public_key: 'your_atlas_public_key'
}
/**
* The atlasPayEvent returns and changes value based on actions carried on , on your payment window.
* i.e onSuccess, onLoad and onClose - this are the events you can watch for using the atlasEvent hook
* */
// you might want to wrap it in a useEffect to carry out action anytime the event fires
useEffect(() => {
if (atlasEvent.type === 'onClose') {
// do something here if user closes the window
}
if (atlasEvent.type === 'onLoad') {
// do something here if the payment window gets loaded
}
if (atlasEvent.type === 'onSuccess') {
// do something here if the payment was successful i.e you can forcefully shutdown the payment window on successful payment, by default the payment window remains open on successful payment
pay({ shutdown: true })
}
}, [atlasEvent])
return (
<div
onClick={() => {
pay(config)
}}
className=""
>
Pay Button
{/* Clicking on this button will generate a payment request and initializes the payment window */}
</div>
)
}
If you don't need to generate a new payment request, 'i.e already have a payment reference', you can initialize the payment window directly py parsing the trx_ref as shown below.
<div
onClick={() => {
pay({ trx_ref: 'your_payment_reference' })
}}
className=""
>
{/* Clicking on this button will generate a payment request and initializes the payment window */}
</div>
React Atlas Pay Library can also be used in a NextJS Environment but requires extra configuration, AtlasPay offers AtlasNext which is NextJS Wrapper for AtlasPay to make use of this you need to call it either within your _app.tsx or _document.tsx this can be found in your nextjs src folder, below is an example usage;
import { Manrope } from "@next/font/google";
import type { AppProps } from "next/app";
import Head from "next/head";
import {AtlasNext} from "react-atlas-pay";
const manrope = Manrope({ subsets: ["latin"] });
export default function App({ Component, pageProps }: AppProps) {
return (
<>
<Head>
<meta name="viewport" content="width=device-width, initial-scale=1" />
</Head>
<main className={manrope.className}>
<Component {...props.pageProps} />
</main>
<AtlasNext/> {/* Here we instantiate the AtlasNext Wrapper */}
);
}
AtlasPay by Raven bank is licensed under the MIT
FAQs
Raven Atlas Payment React library
The npm package react-atlas-pay receives a total of 16 weekly downloads. As such, react-atlas-pay popularity was classified as not popular.
We found that react-atlas-pay demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.