payercoins-react
v0.0.2
Published
Official React package for Payercoins
Downloads
4
Readme
Payercoins Official react sdk
Payercoins SDK allows you accept payments easily in your react application
Installation
npm install payercoins-react
or
yarn add payercoins-react
Usage
import { usePayercoins } from 'payercoins-react'
const App = () => {
config = {
key: 'PUBLIC_KEY', //string
customer_name: "CUSTOMERS NAME", //string
customer_email: "CUSTOMERS EMAIL", //string
amount: parseFloat('20.00'), // amount as a number or string
currency: ['ethereum'], // Array of currency slug.
description: 'Test Payment', // optional
redirect_url: '', // optional - will default to current page
invoice_id: "239313200190.40646", // optional - unique identifier for your payment and minLength 8, else we will automatically generate one
callback_url: 'https://sandbox-api.payercoins.com/api/v1/withdrawal' //This is just a test sandbox
}
const [initializePayment] = usePayercoins();
const handlePayment = async () => {
await initializePayment(config);
};
return (
<div>
<h1>Payercoins React test</h1>
<button onClick={handlePayment}>Pay with Payercoins</button>
</div>
);
}
Configuration Options
key
string: Required Your public key can be found on your dashboard settings.
customer Name
string: Required The name of the customer trying to carry out a transaction
customer Email
string: Required The customers email
currency
[string]: Required The currency has to be filed an array of strings of a users enabled coins example
["ethereum", "bitcoin", "usdt-trx", "usdt-bep", "busd-bep","usdc-bep"]
amount
number | string: Required
The amount that is to be paid to settle the transaction currency
description
object : Optional This contains any additional information you want to pass with this transaction
invoice_id
string : Optional unique identifier for your payment
redirect_url
string : Optional The page where you want the customer to be directed to after payment, if not user will be directed to the current page
callback_url
string: Required