fraud_protection

Collection: fraud_protections

A fraud protection is a configuration of your fraud protection controls such as minFraud which allow you to set thresholds for when a transaction should be rejected based on the information known about the customer placing the order. Currently supported fraud protections include MaxMind's minFraud, Google reCAPTCHA, and your own Pre-Payment Webhook.

To create a fraud protection, POST to the fraud_protections link relationship of a store. To enable that fraud protection on a payment method set, POST to the payment_method_set_fraud_protections link relationship using the self link relationship from this resource as the fraud_protection_uri.

Notes

The json property contains configuration specific to each fraud protection type:

Google reCAPTCHA json properties:

  • config: Determines how reCAPTCHA operates. Values: disabled, enabled_always, or enabled_by_errors.
  • private_key: Your Google reCAPTCHA Private Key. Required if using a custom subdomain, empty otherwise.
  • site_key: Your Google reCAPTCHA Site Key. Required if using a custom subdomain, empty otherwise.

Pre-Checkout Hook json properties:

  • enabled: Whether or not the Pre-Checkout Hook is enabled. Boolean.
  • url: URL of your Pre-Checkout Hook. Required.
  • failure_handling: If your Pre-Checkout Hook is unavailable, determines if checkout should be rejected or approved.

Required Scopes

Full store_full_access
Read payment_settings_read
Write payment_settings_write

Actions

GET View a fraud protection
PATCH Update a fraud protection (send only the properties you want to modify)
PUT Replace a fraud protection (send the entire representation)
DELETE Delete a fraud protection
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (6)

type String · Required

The type of this fraud protection.

minfraudgoogle_recaptchacustom_precheckout_hook
description String · max 100

Description of this fraud protection.

Default: Default Min Fraud

json String · Required

Configuration settings for some fraud protection systems. A JSON string containing type-specific configuration.

Required for google_recaptcha and custom_precheckout_hook.

score_threshold_reject Number · Optional

The score threshold used for minfraud. This should be set between 0 and 100. 0 will disable minFraud and 100 will turn it on for logging but still allow all transactions to go through.

0 to disable.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (3)

self This Fraud Protection
fx:store GET PATCH PUT DELETE This Store
fx:payment_method_sets GET POST Payment Method Sets for this store
https://api.foxycart.com/fraud_protections/{id}
Available via fx:fraud_protection on payment_method_set_fraud_protection

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/fraud_protections/123",
      "title": "This Fraud Protection"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:payment_method_sets": {
      "href": "https://api.foxycart.com/stores/456/payment_method_sets",
      "title": "Payment Method Sets for this store"
    }
  },
  "type": "google_recaptcha",
  "description": "Google reCAPTCHA",
  "json": "{\"private_key\":\"\",\"site_key\":\"\",\"config\":\"disabled\"}",
  "score_threshold_reject": 0,
  "date_created": "2015-05-27T08:59:54-0700",
  "date_modified": "2015-05-27T08:59:54-0700"
}