https://github.com/thepeerstack/thepeer-react
Thepeer's react library
https://github.com/thepeerstack/thepeer-react
payment react sdk-react
Last synced: 2 months ago
JSON representation
Thepeer's react library
- Host: GitHub
- URL: https://github.com/thepeerstack/thepeer-react
- Owner: thepeerstack
- License: mit
- Created: 2022-01-13T13:03:26.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T21:51:31.000Z (almost 3 years ago)
- Last Synced: 2025-10-01T23:44:36.672Z (6 months ago)
- Topics: payment, react, sdk-react
- Language: TypeScript
- Homepage: https://thepeer.co
- Size: 573 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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
```sh
npm install thepeer-react
```
## Usage
```js
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 (
Thepeer SDKs
Send
Direct Charge
Checkout
)
}
```
## Configuration Options
- [`publicKey`](#publicKey)
- [`userReference`](#userReference)
- [`amount`](#amount)
- [`currency`](#currency)
- [`onSuccess`](#onSuccess)
- [`onError`](#onError)
- [`onClose`](#onClose)
- [`meta`](#meta)
**string: Required**
Your public key can be found on your [dashboard](https://dashboard.thepeer.co) settings.
**string: Required**
The user reference returned by Thepeer API when a user has been indexed
**string | number: Required**
The amount you intend to send in kobo
**string: Optional**
The currency being used. Defaults to **NGN**
**(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](#thepeerEvent) below.
**(response) => void: Required**
This is called when a transaction fails. It returns a response with event type
See the [event details](#thepeerEvent) below.
**(response) => void: Required**
This is called when a user clicks on the close button.
**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 . We're more than happy to help you out.
## Thepeer API References
- [Thepeer API Docs](https://docs.thepeer.co)
- [Thepeer Dashboard](https://dashboard.thepeer.co)
## License
[MIT](https://github.com/thepeerstack/thepeer-react/blob/master/LICENSE) for more information.