> For the complete documentation index, see [llms.txt](https://prepaidify.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prepaidify.gitbook.io/docs/virtual-card/api-integration/risk-control-webhook.md).

# Risk Control webhook

### Description

Risk control notification webhook configuration and usage:

* Please contact the staff to configure your Webhook Endpoint Url in the backend, which must be HTTPS
* When risk data appears, corresponding transaction messages will be pushed to your Webhook Endpoint Url
* After receiving a Webhook message, if HTTP CODE 200 is returned, it indicates that you have successfully received the Webhook message. Otherwise, we will try again

### Parameter

| Parameter              | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| eventType              | string    | Webhook Event Type                                                                                                                                                                                                                                                                                                                                                                                                   |
| eventId                | string    | Webhook Event ID                                                                                                                                                                                                                                                                                                                                                                                                     |
| webhookSubscribeId     | string    | Webhook subscription ID                                                                                                                                                                                                                                                                                                                                                                                              |
| +data                  | object    |                                                                                                                                                                                                                                                                                                                                                                                                                      |
| └userId                | string    | User ID                                                                                                                                                                                                                                                                                                                                                                                                              |
| └cardIds               | List      | Card IDs controlled by risk                                                                                                                                                                                                                                                                                                                                                                                          |
| └numbers               | List      | Card numbers controlled by risk                                                                                                                                                                                                                                                                                                                                                                                      |
| └type                  | string    | <p>FREEZE\_CARD<br>FREEZE\_ACCOUNT</p>                                                                                                                                                                                                                                                                                                                                                                               |
| └riskControlReasonType | string    | <p>HIGH <em>REFUSE</em> RATE: High refusal rate<br>CONSECUTIVE <em>DECLINED</em> DUE <em>TO</em> ACCOUNT <em>NOT</em> ENOUGH: Continuous refusal to pay due to insufficient balance<br>ZERO <em>PENDING</em> MANY <em>TIMES: Multiple 0Pending</em><br><em>CARD</em> OverDRAW: Card overdraft<br>ACCOUNT <em>OverDRAW: Account overdraft</em><br><em>MANY</em> FREEZE <em>CARD</em> COUNT: Too many frozen cards</p> |
| └reason                | string    | Risk control reason                                                                                                                                                                                                                                                                                                                                                                                                  |
| └gmtCreate             | timestamp | Record creation time                                                                                                                                                                                                                                                                                                                                                                                                 |

### Response Example

```
{
    "eventType":"RISK_CONTROL",
    "eventId":"ev_xxxxxxxxxxxxxxxxxxxxx",
    "webhookSubscribeId":"wsb_xxxxxxxxxxxxxxxxxxx",
    "data":{
          "userId": "u_123",
          "cardIds": [
            "c_12312"
          ],
          "numbers": [
            "55676612313"
          ],
          "type": "FREEZE_CARD",
          "riskControlReasonType": "HIGH_REFUSE_RATE",
          "reason": "xxxxxxx"
        }
}
```