credo-react-native-webview
v1.0.0
Published
The package allows you accept payment using credo
Downloads
3
Readme
Credo-React-Native-Webview
The package allows you accept payment using credo
Installation
Add Credo-React-Native-Webview to your project by running;
npm install credo-react-native-webview react-native-webview
or
yarn add credo-react-native-webview react-native-webview
for iOS: cd iOS && pod install && cd ..
Example Usage
import React, { useState } from 'react';
import { View, Text } from 'react-native';
import { Credo } from 'credo-react-native-webview';
const Pay = () => {
const [modalVisible, setModalVisible] = useState(false);
const closeModal = () => setModalVisible(false);
const handleSubmit = () => setModalVisible(true);
return (
<View style={{ flex: 1 }}>
Î<Credo
amount={3500}
currency="NGN"
customerEmail="[email protected]"
customerName="Credo Dibs"
customerPhoneNo="08090000000"
publicKey="your-public-key"
showModal={modalVisible}
onSuccess={(response) => {
//handle response
}}
closeModal={closeModal}
/>
<Pressable onPress={handleSubmit} title="Submit">
<Text>Test Payment</Text>
</Pressable>
</View>
);
}
API's
All Credo-React-Native-Webview API
API
| Property | Type | Required | Description |
| ------------------ | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| publicKey | string
| ✔️ | Public Credo key(visit credocentral.com to get yours) |
| amount | string
or number
| ✔️ | amount to be charged, should be greater than #100
| customerEmail | string
| ✔️ | Customer's email address email
| customerName | string
| ✔️ | Customer's name |
| customerPhoneNo | string
| ✔️ | Customer's phone number
| referenceNo | string
| | Reference number, if you have already generated one. This would be auto generated by Credo if you don't provide it.
| showModal | boolean
| ✔️ | Set modal visibility. When it is true, the Credo Payment widget pops up.
| closeModal | Function
| ✔️ | Function to be called to set showModal
to false
.
| onSuccess | Function
| ✔️ | Function to be called after a successful transaction. You can provide a function that looks like this: (successResponse: SuccessResponse) => void;
| onCancel | Function
| | callback function if user cancels or payment transaction could not be verified.
Contributions
Would you like to contribute to this package? Read how to contribute and send in your PR!
Licensing
This project is licensed under MIT license.
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!