thepeer-react
v0.0.7
Published
Official React package for Thepeer
Downloads
40
Maintainers
Readme
thepeer-react
Official React package for Thepeer
Thepeer React package
Thepeer is a quick and secure way to send money across any business. The SDK handles connecting other businesses to your app.
Installation
npm install thepeer-react
Usage
import React from 'react'
import { useSend, useDirectCharge, useCheckout } from 'thepeer-react'
// ...
export default function App() {
const config = {
publicKey: 'PUBLIC_KEY',
amount: 'AMOUNT_IN_KOBO',
currency: 'NGN',
meta: {
discount: 'black friday'
}
}
const handleSendPayment = useSend({
...config,
userReference: 'USER_REFERENCE'
})
const handleDirectChargePayment = useDirectCharge({
...config,
userReference: 'USER_REFERENCE'
})
const handleCheckoutPayment = useCheckout(config)
return (
<div className='App'>
<h1>Thepeer SDKs </h1>
<button onClick={handleSendPayment}>Send</button>
<button onClick={handleDirectChargePayment}>Direct Charge</button>
<button onClick={handleCheckoutPayment}>Checkout</button>
</div>
)
}
Configuration Options
publicKey
string: Required Your public key can be found on your dashboard settings.
userReference
string: Required The user reference returned by Thepeer API when a user has been indexed
amount
string | number: Required The amount you intend to send in kobo
currency
string: Optional The currency being used. Defaults to NGN
onSuccess
(response) => void: Required This is called when a transaction is successfully. It returns a response with event type and transaction details.
See the event details below.
onError
(response) => void: Required This is called when a transaction fails. It returns a response with event type
See the event details below.
onClose
(response) => void: Required This is called when a user clicks on the close button.
meta
object: Optional This object should contain additional/optional attributes you would like to have on your transaction response
Support
If you're having trouble with Thepeer React or your integration, please reach out to us at [email protected]. We're more than happy to help you out.
Thepeer API References
License
MIT for more information.