fraud_protections

Resource: fraud_protection

This link relationship returns a collection of fraud protections. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read payment_settings_read
Write payment_settings_write

Collection Resource

fraud_protection

Actions

GET View a list of fraud_protections
POST Create a new fraud protection
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:fraud_protections[] — array of fraud_protection resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/fraud_protections
Available via fx:fraud_protections on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/fraud_protections",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/fraud_protections?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/fraud_protections?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/fraud_protections?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/fraud_protections?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:fraud_protections": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/fraud_protections/456",
            "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"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}