{"title":"Fraud results in API responses and webhooks","category":"default","creationDate":1779620071,"content":"

Webhooks<\/a> inform your server of\u00a0payment events<\/a>,\u00a0modifications<\/a>, and newly available\u00a0reports<\/a>. Webhooks can also inform you when payment requests trigger risk rules.<\/p>\n

You can include risk information, such as whether a payment was sent to case management, and which risk rules triggered in these webhooks, as well as in the payment response.<\/p>\n

\n

Returning fraud results is not turned on by default. When you configure your account to include risk information, it affects the format of both webhooks and the payment response.<\/p>\n<\/div>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements and limitations.<\/p>\n\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nMake sure that you have built an online payments integration<\/a> and that risk is enabled<\/a>.<\/td>\n<\/tr>\n
Customer Area roles<\/a><\/strong><\/td>\nTo manage webhooks and what is returned in the API response, make sure that you have the following role(s):
  • Merchant technical integrator<\/strong><\/li><\/ul>To manage risk settings, make sure that you have one of the following role(s):
    • Merchant change risk settings<\/strong><\/li>
    • Risk admin<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
Limitations<\/strong><\/td>\nYou can only return information about custom risk rules and the fraud risk level when you have enabled premium features<\/a>.<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\nBefore you begin: