Create Fraud Rule

POST

/api/:account_id/fraud-rules/

POST

/api/:account_id/fraud-rules/

$ curl -X POST https://app.paymentkit.com/api/account_id/fraud-rules/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Block High-Risk Countries",
>   "conditions": [
>     {
>       "field": "country",
>       "operator": "equals",
>       "value": "NG"
>     }
>   ]
> }'

1 {
2   "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a1d9e",
3   "name": "Block High-Risk Countries",
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 }

Create a new fraud prevention rule.

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

namestringRequired<=255 characters

Rule name

conditionslist of objectsRequired

List of conditions

logicenumOptionalDefaults to AND

Condition logic: AND or OR

enabledbooleanOptionalDefaults to true

Whether the rule is active

actionenumOptionalDefaults to block

Rule outcome on match. ‘allow’ approves the transaction (overrides any block rule); ‘block’ rejects it.

transaction_scopeenumOptionalDefaults to cit

Which transactions the rule applies to: ‘cit’ (interactive/checkout, the default), ‘mit’ (off-session renewals/dunning), or ‘all’.

reasonstringOptional<=500 charactersDefaults to

Optional reason shown to the customer when a ‘block’ rule matches. The block-reason input was removed from the rule builder per design, so this is no longer required; blocked transactions fall back to the account-level custom message.

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