Update Fraud Rule

PATCH

/api/:account_id/fraud-rules/:rule_id

Update a fraud rule.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

rule_idstringRequired

account_idstringRequired

Request

This endpoint expects an object.

namestring or nullOptional<=255 characters

Rule name

logicenum or nullOptional

Condition logic: AND or OR

enabledboolean or nullOptional

Whether the rule is active

actionenum or nullOptional

Rule action: block or allow

transaction_scopeenum or nullOptional

Which transactions the rule applies to: ‘cit’, ‘mit’, or ‘all’.

reasonstring or nullOptional<=500 characters

Reason shown to the customer for block rules. Ignored for allow rules.

conditionslist of objects or nullOptional

List of conditions

Response

Successful Response

idstring

Unique rule identifier

namestring

Rule name

logicenum

Condition logic: AND or OR

enabledboolean

Whether the rule is active

actionenum

Rule action: block or allow

transaction_scopeenum

Which transactions the rule applies to: ‘cit’, ‘mit’, or ‘all’.

reasonstring

Block reason

conditionslist of objects

List of conditions

created_atdatetime

When the rule was created

updated_atdatetime

When the rule was last updated

Errors

422

Unprocessable Entity Error

$	curl -X PATCH https://app.paymentkit.com/api/account_id/fraud-rules/rule_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3	"name": "High Risk Country Block",
4	"logic": "AND",
5	"enabled": true,
6	"action": "block",
7	"transaction_scope": "cit",
8	"reason": "Transactions from this country are blocked due to high fraud risk.",
9	"conditions": [
10	{
11	"field": "country",
12	"operator": "equals",
13	"value": "NG"
14	}
15	],
16	"created_at": "2024-01-15T09:30:00Z",
17	"updated_at": "2024-01-15T09:30:00Z"
18	}