PUT /risk-score-rules

Modifies risk score rules.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
hasMismatchedBankCountry Object Yes

Specifies whether the customer's bank country and geo-IP address are not the same.

hasMismatchedBankCountry.value Integer Yes

Value added to the risk score of the transaction.

isVpn Object Yes

Specifies whether the customer's IP address is related to a VPN.

isVpn.value Integer Yes

Value added to the risk score of the transaction.

customerLifetimeValue Object Yes

Total revenue from the customer, in USD.

customerLifetimeValue.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

customerLifetimeValue.brackets[].end Integer No

Maximal risk factor value when condition is applied.

customerLifetimeValue.brackets[].value Integer Yes

Value added to the risk score of the transaction.

customerLifetimeValue.brackets[].start Integer No

Minimal risk factor value when condition is applied.

hasMismatchedHolderName Object Yes

Specifies whether the customer's billing address name and primary address name are not the same.

hasMismatchedHolderName.value Integer Yes

Value added to the risk score of the transaction.

emailVelocity Object Yes

Number of transactions for this email address in the last 24 hours.

emailVelocity.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

emailVelocity.brackets[].end Integer No

Maximal risk factor value when condition is applied.

emailVelocity.brackets[].value Integer Yes

Value added to the risk score of the transaction.

emailVelocity.brackets[].start Integer No

Minimal risk factor value when condition is applied.

hasMismatchedBillingAddressCountry Object Yes

Specifies whether the customer's billing address country and geo-IP address are not the same.

hasMismatchedBillingAddressCountry.value Integer Yes

Value added to the risk score of the transaction.

declinedPaymentInstrumentVelocity Object Yes

Number of declined transactions for this payment instrument fingerprint in the last 24 hours.

declinedPaymentInstrumentVelocity.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

declinedPaymentInstrumentVelocity.brackets[].end Integer No

Maximal risk factor value when condition is applied.

declinedPaymentInstrumentVelocity.brackets[].value Integer Yes

Value added to the risk score of the transaction.

declinedPaymentInstrumentVelocity.brackets[].start Integer No

Minimal risk factor value when condition is applied.

browserAdBlockEnabled Object Yes

Specifies whether an ad blocker was detected.

browserAdBlockEnabled.value Integer Yes

Value added to the risk score of the transaction.

billingAddressVelocity Object Yes

Number of transactions for this billing address in the last 24 hours.

billingAddressVelocity.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

billingAddressVelocity.brackets[].end Integer No

Maximal risk factor value when condition is applied.

billingAddressVelocity.brackets[].value Integer Yes

Value added to the risk score of the transaction.

billingAddressVelocity.brackets[].start Integer No

Minimal risk factor value when condition is applied.

isHosting Object Yes

Specifies whether the customer's IP address is related to hosting.

isHosting.value Integer Yes

Value added to the risk score of the transaction.

isRebill Object Yes

Specifies whether the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.

isRebill.value Integer Yes

Value added to the risk score of the transaction.

customerVelocity Object Yes

Number of transactions for this customer in the last 24 hours.

customerVelocity.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

customerVelocity.brackets[].end Integer No

Maximal risk factor value when condition is applied.

customerVelocity.brackets[].value Integer Yes

Value added to the risk score of the transaction.

customerVelocity.brackets[].start Integer No

Minimal risk factor value when condition is applied.

isRetry Object Yes

Specifies whether the transaction is a retry.

isRetry.value Integer Yes

Value added to the risk score of the transaction.

isProxy Object Yes

Specifies whether the customer's IP address is related to a proxy.

isProxy.value Integer Yes

Value added to the risk score of the transaction.

deviceVelocity Object Yes

Number of transactions for this device, based on fingerprint, in the last 24 hours.

deviceVelocity.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

deviceVelocity.brackets[].end Integer No

Maximal risk factor value when condition is applied.

deviceVelocity.brackets[].value Integer Yes

Value added to the risk score of the transaction.

deviceVelocity.brackets[].start Integer No

Minimal risk factor value when condition is applied.

paymentInstrumentApprovedTransactionCount Object Yes

Number of approved transactions for this payment instrument.

paymentInstrumentApprovedTransactionCount.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

paymentInstrumentApprovedTransactionCount.brackets[].end Integer No

Maximal risk factor value when condition is applied.

paymentInstrumentApprovedTransactionCount.brackets[].value Integer Yes

Value added to the risk score of the transaction.

paymentInstrumentApprovedTransactionCount.brackets[].start Integer No

Minimal risk factor value when condition is applied.

hasMismatchedTimeZone Object Yes

Specifies whether the customer's browser time zone and the IP address associated time zone are not the same.

hasMismatchedTimeZone.value Integer Yes

Value added to the risk score of the transaction.

ipVelocity Object Yes

Number of transactions for this IP address in the last 24 hours.

ipVelocity.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

ipVelocity.brackets[].end Integer No

Maximal risk factor value when condition is applied.

ipVelocity.brackets[].value Integer Yes

Value added to the risk score of the transaction.

ipVelocity.brackets[].start Integer No

Minimal risk factor value when condition is applied.

hasFakeName Object Yes

Specifies whether the holder name seems fake.

hasFakeName.value Integer Yes

Value added to the risk score of the transaction.

isTor Object Yes

Specifies whether the customer's IP address is related to TOR.

isTor.value Integer Yes

Value added to the risk score of the transaction.

isHighRiskCountry Object Yes

Specifies whether the geo-IP country, or the customer's billing country, is considered a high risk country.

isHighRiskCountry.value Integer Yes

Value added to the risk score of the transaction.

paymentInstrumentVelocity Object Yes

Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.

paymentInstrumentVelocity.brackets[] Array Yes

Risk factor values range with corresponding risk score increment value. The first matched bracket is applied.

paymentInstrumentVelocity.brackets[].end Integer No

Maximal risk factor value when condition is applied.

paymentInstrumentVelocity.brackets[].value Integer Yes

Value added to the risk score of the transaction.

paymentInstrumentVelocity.brackets[].start Integer No

Minimal risk factor value when condition is applied.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.