---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/notes/zh/risk/safePayGuardJs/index.md
description: >-
  SafePayGuardJs是支付过程中的风险控制插件，用于预防欺诈、保障资金安全及优化用户体验。适用于需要加强在线交易安全性的场景。初始化时需设定环境参数（SANDBOX或PRODUCTION），并调用getGeneratedData方法获取设备指纹等风控信息，以增强支付请求的安全性。
---
**SafePayGuardJs**是一个用于支付过程中的风险控制插件，包括预防欺诈行为、保护资金安全，提升用户体验。

##  安装

```javascript
<script src="https://pay-cdn.pingpongx.com/production-fra/static/safe-pay-guard/safePayGuard.min.js"></script>
```

## 初始化

### 定义初始化参数

::: danger 
沙箱联调请填入`env`=`SANDBOX`, 生产环境请填入`env`=`PRODUCTION`。
:::

```javascript
const options = {
    env: 'DEV', // 'SANDBOX'|'PRODUCTION'
    accId: accId,
    clientId: clientId,
    requestId: requestId,
    merchantUserId: merchantUserId,
}

```

### 初始化

```javascript
SafePayGuardJs.init(options)
```

## 获取generatedData

在完成初始化后，该插件会自行收集设备指纹和风控所需参数，真正发起支付请求前, 你只需要调用插件提供的 `getGeneratedData` 方法进行获取（以下均称其为 generatedData），并在后续支付中传入。
示例：

```javascript
const generatedData = SafePayGuardJs.getGeneratedData()

// generatedData: 
{
    fingerPrint: string;
    forterSiteId: string;
    forterTokenCookie: string | null;
    riskExtendInfos: [{
        channelCode: "1xxxxx0x",
        metadata: "xxx5xxxd5dxxxxxeaxxxxxxxdxfxx"
    }]
}

```