@armenotech/fpf
v0.0.313
Published
Fast payment flow React component
Downloads
118
Keywords
Readme
📄 API
| Property | Description | Type | Default | Required |
|------------------------|----------------------------------------------------------------------------------------------------------------------------------|-----------------|-------|-------------------------|
| type | Payment flow type. Available types: deposit
and withdraw
. | string | deposit
|
| customerId | Customer id. | string | | required |
| token | Authorization JWT token. | string | | required |
| amount | Amount. If you are using the attribute amount
you can't edit amount field manually. | number / string | |
| txCallbackUrl | Url for POST request on merchant’s backend where it accepts HTTP callbacks about a deposit or withdraw transaction is initiated. | string | | required |
| merchantToken | Auth JWT token for merchant txCallbackUrl
. | string | | required |
| redirectUrl | Url where will be redirected user after successful transaction. | string | |
| mainBrandColor | You can change main brand color of color scheme. |
| kyc | Enable if you are using KYC (@armenotech/kyc-sep12) | boolean | false
|
| customerId | Customer ID | string | | required for kyc property |
| fee_mod | Compensation of fee | object | | |
| updateTransactionToken | Update transaction token callback | () => string | | |
| apiEndpoints | API endpoints domain name | object | | required ||
| currencyAssets | Currency assets | object | | required |
| apiVersion | API version | string | v1
| |
| tomlData | TOML file data | object | | required |
| isProdMod | Production mod | boolean | false
| |
Running in dev mode
$ export HTTP_PORT=<whatever port number you preferring> ## for example 5050
$ npm run start
Compiled successfully in 6130 ms.
The app is running at http://0.0.0.0:5050/