payment_gateways

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

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

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:payment_gateways": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/payment_gateway">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>

{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: payment_gateway

Description

A payment gateway stores the account information for your payment card gateway processor. You can assign a single payment gateway to a payment gateway set which controls if the processor is in live or in test mode.

To create a payment gateway, POST to the payment_gateways link relationship of a store. When create a payment_method_set you can then use the payment_gateway_uri from the self link relationship of this resource.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

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

Properties

Property Description Type Constraints
description Description of this payment gateway String 100 characters or less, will default to the gateway name.
type Valid payment gateway type. String Required. payment_gateways
account_id Your payment gateway account id. To view the specific description of this field for the given payment gateway, see payment_gateways property helper id_description field. String Optional. 500 characters or less.
account_key Your payment gateway account key. To view the specific description of this field for the given payment gateway, see payment_gateways property helper key_description field. String Optional. 1000 characters or less.
third_party_key Your payment gateway third party key. To view the specific description of this field for the given payment gateway, see payment_gateways property helper third_party_key_description field. String Optional. 500 characters or less.
config_3d_secure Configuration settings for 3D Secure. String Optional. Either all_cards, maestro_only, all_cards_require_valid_response, maestro_only_require_valid_response.
additional_fields Additional configuration details specific to each payment gateway. String Optional. 1000 characters or less.
test_account_id Your test payment gateway account id. To view the specific description of this field for the given payment gateway, see payment_gateways property helper id_description field. String Optional. 500 characters or less.
test_account_key Your test payment gateway account key. To view the specific description of this field for the given payment gateway, see payment_gateways property helper key_description field. String Optional. 1000 characters or less.
test_third_party_key Your test payment gateway third party key. To view the specific description of this field for the given payment gateway, see payment_gateways property helper third_party_key_description field. String Optional. 500 characters or less.
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api-sandbox.foxycart.com/payment_gateways/377",
            "title": "Default Payment Gateway"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/8",
            "title": "This Store"
        },
        "fx:payment_method_sets": {
            "href": "https://api-sandbox.foxycart.com/stores/8/payment_method_sets?gateway_id=377",
            "title": "Payment method sets using this gateway."
        }
    },
    "description": "Default Payment Gateway",
    "type": "authorize",
    "use_auth_only": false,
    "account_id": "",
    "account_key": "",
    "third_party_key": "",
    "config_3d_secure": "",
    "additional_fields": "",
    "test_account_id": "BxFSnPy7",
    "test_account_key": "8SPBTpqs4uf2ZwM8",
    "test_third_party_key": "",
    "date_created": "2014-07-17T06:46:00-0700",
    "date_modified": "2014-07-17T06:46:00-0700"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/payment_gateways/377" rel="https://api.foxycart.com/rels/payment_gateway">
  <link rel="self" href="https://api-sandbox.foxycart.com/payment_gateways/377" title="Default Payment Gateway"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/8" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/payment_method_sets" href="https://api-sandbox.foxycart.com/stores/8/payment_method_sets?gateway_id=377" title="Payment method sets using this gateway."/>
  <description>Default Payment Gateway</description>
  <type>authorize</type>
  <use_auth_only>false</use_auth_only>
  <account_id></account_id>
  <account_key></account_key>
  <third_party_key></third_party_key>
  <config_3d_secure></config_3d_secure>
  <additional_fields></additional_fields>
  <test_account_id>BxFSnPy7</test_account_id>
  <test_account_key>8SPBTpqs4uf2ZwM8</test_account_key>
  <test_third_party_key></test_third_party_key>
  <date_created>2014-07-17T06:46:00-0700</date_created>
  <date_modified>2014-07-17T06:46:00-0700</date_modified>
</resource>

{
    "class": [
        "payment_gateway"
    ],
    "properties": {
        "description": "Default Payment Gateway",
        "type": "authorize",
        "use_auth_only": false,
        "account_id": "",
        "account_key": "",
        "third_party_key": "",
        "config_3d_secure": "",
        "additional_fields": "",
        "test_account_id": "BxFSnPy7",
        "test_account_key": "8SPBTpqs4uf2ZwM8",
        "test_third_party_key": "",
        "date_created": "2014-07-17T06:46:00-0700",
        "date_modified": "2014-07-17T06:46:00-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/payment_gateways/377"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/8"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/payment_method_sets"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/8/payment_method_sets?gateway_id=377"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.