payment_gateways

Resource: payment_gateway

This link relationship returns a collection of payment gateways. 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

payment_gateway

Actions

GET View a list of payment_gateways
POST Create a new payment gateway
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:payment_gateways[] — array of payment_gateway 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}/payment_gateways
Available via fx:payment_gateways on property_helpers·fx:payment_gateways 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/payment_gateways",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/payment_gateways?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/payment_gateways?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/payment_gateways?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/payment_gateways?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:payment_gateways": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/payment_gateways/456",
            "title": "This Payment Gateway"
          },
          "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?gateway_id=123",
            "title": "Payment method sets using this gateway."
          }
        },
        "description": "Default Payment Gateway",
        "type": "authorize",
        "use_auth_only": false,
        "account_id": "",
        "account_key": "",
        "third_party_key": "",
        "card_verification": "",
        "card_verification_config": "",
        "config_3d_secure": "",
        "additional_fields": "",
        "test_account_id": "BxFSnPy7",
        "test_account_key": "8SPBTpqs4uf2ZwM8",
        "test_third_party_key": "",
        "test_card_verification": "",
        "test_card_verification_config": "",
        "date_created": "2014-07-17T06:46:00-0700",
        "date_modified": "2014-07-17T06:46:00-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}