@payoneer/op-risk-lib v1.3.0
RiskLib (Risk Client Library)
Client-Side (Javascript) library used to
- Load/initialize 3rd-party risk-provider scripts inside iframes
- Collect data from those 3rd-party risk-provider scripts
- Return stored data in a specific format (at any given time)
You only need to use it as a standalone library if you are building your own native integration to Payoneer Checkout APIs. It is included in our Web SDK by default, which is usually the best way to integrate our payment services on your checkout page.
Documentation and examples can be found here: https://checkoutdocs.payoneer.com/docs/add-your-js-risk-library
Installation
Install the library directly from npm by executing the following command
npm install @payoneer/op-risk-lib
Usage
The library is exposed in multiple form.
As a JS Module
Import
RiskLib
to use the library.
import RiskLib from "@payoneer/op-risk-lib";
As commonJs
Require
RiskLib
to use the library.
const RiskLib = require("@payoneer/op-risk-lib");
As a script (iife)
Use the file named
op-risk-lib.js
with .js extension. Once loaded, access a global variable/instance namedRiskLib
to use the library.
<script type="text/javascript" src="https://checkout.payoneer.com/web/libraries/risk/op-risk-lib.js"></script>
Methods
The library exposes following methods
init
Method to initialize the library. It requires an array of input configs
(riskProviders
key's value from LIST response) that is used to configure/initialize library.
During the initialization process, library reads the input config, validates it, filters invalid configs
and generates dynamic iframe for the valid configs to load the 3rd-party risk-provider scripts
Method Parameters
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
riskProviderConfigs | []Object | true | riskProviders key's value from LIST response |
Example (usage)
RiskLib.init([{...}]);
getRiskData
Returns an array of stored information in a specific format
Example (usage)
const data = RiskLib.getRiskData();
destroy
Remove all content generated by library. That includes dynamically created iframes, stored data and event listeners
Example (usage)
RiskLib.destroy();
configureExternalStorage
Method to configure and external storage to temporarily store the received information from risk-provider scripts
Library comes with internal storage, configuring external storage is optional
Method Parameters
NAME TYPE REQUIRED DESCRIPTION setData function true callback that receives key
,value
as parametersgetData function true callback that receives key
as parameterremoveData function true callback that receives key
as parameterExample (usage)
const storeData = (key, value) => { ...code }; const getData = (key) => { ...code }; const removeData = (key) => { ...code };
RiskLib.configureExternalStorage(storeData, getData, removeData);
---
<br />
## License
`op-risk-lib` is licensed under [Payoneer](./LICENSE)