sahl-acceptance
v1.1.5
Published
payment acceptance package
Downloads
13
Readme
Table of Contents
Install
Install the latest version to your package.json
:
// install external dependencies
$ npm install react-native-webview react-native-svg --save
// install package
$ npm install sahl-acceptance --save
Usage
import UseSahlAcceptance from 'sahl-acceptance';
import { Stage } from 'sahl-acceptance/Common/Constants';
<UseSahlAcceptance
apiKey={'API_KEY'}
requestHashKey={'REQUEST_HASH_KEY'}
username={'USERNAME'}
password={'PASSWORD'}
stage={Stage.Staging or Stage.Sandbox or Stage.Production}
paymentDetails={
{
"customer_id": 1,
"paid_amount": 10.00,
}
}
style={{mainColor: '#4055FF', buttonBorderRadius: 120, inputFieldBorderRadius: 100}}
onSuccess={(response) => {
console.log(response);
alert('Payment completed successfully')
}}
onFailure={(response) => {
console.log(response);
alert('Payment failed');
}}
onError={(errorMessage) => alert(errorMessage)}
/>
Properties
All of the following properties are required
apiKey
(string): Your integration API Key; this to be able to call our APIs.requestHashKey
(string): Your request hash key; this for signing the requests.username
(string): Your API username; this for authentication.password
(string): Your API password; this for authentication.stage
(Enum): The desired environment stage; available values areStage.Staging or Stage.Sandbox or Stage.Production
.paymentDetails
(object): This is the actual payment details that requires you to specify the following fields:customer_id
(integer): This is your customer id and its expcted to be integer number.paid_amount
(decimal): This is the amount that you need customer to pay.
style
(object): This is custom style for youmainColor
(string): This is the main color.buttonBorderRadius
(string): This is the border radius that will be applied on any button.inputFieldBorderRadius
(string): This is the border radius that will be applied on any input field.
Events
onSuccess
: Called once when the payment is succeeded.onFailure
: Called once when the payment is failed.onError
: Called whenever an error occured.