payment_gateways : Foxy hAPI

payment_gateways

Description

This property helper lets you know which payment gateways we currently support.

The values JSON object has the following properties

name: The name of this payment gateway.
id_description: The description of the id field for this gateway.
test_id: The default id you can use for testing this gateway.
key_description: The description of the key field for this gateway.
test_key: The default key you can use for testing this gateway.
third_party_key_description: The description of the third party key field for this gateway.
test_third_party_key: The default third party key you can use for testing this gateway.
supports_auth_only: Whether or not this gateway supports authorize only instead of auth+capture.
supports_multi_currency: Whether or not this gateway supports multiple currencies. If false, the currency set in Foxy will be ignored by the gateway, so you must ensure your Foxy account matches the currency of the gateway account.
supports_3d_secure: Whether or not this gateway supports 3D Secure functionality.
is_deprecated: True if this gateway is deprecated and should no longer be used.
additional_fields: If this gateway requires additional information, this will contain details about the data which needs to be collected to configure this gateway.

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_gateways
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

Property	Description	Type	Constraints
message	A small, human readable explanation of this property helper.	String	Read only
values	JSON objects with the gateway type as the object key and various properties and there values.	JSON	Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api.foxycart.com/property_helpers/payment_gateways",
            "title": "List of supported Payment Gateways and valid entries for that resource's type setting."
        },
        "fx:property_helpers": {
            "href": "https://api.foxycart.com/property_helpers",
            "title": "Property Helpers Home"
        }
    },
    "message": "The key values listed here are the correct values for the PaymentGateway type field. It also includes all of the additional default values for a payment gateway.",
    "values": {
      "authorize": {
        "name": "Authorize.net",
        "id_description": "API ID",
        "test_id": "BxFSnPy7",
        "key_description": "Transaction Key",
        "test_key": "8SPBTpqs4uf2ZwM8",
        "third_party_key_description": "",
        "test_third_party_key": "",
        "supports_auth_only": 1,
        "supports_multi_currency": false,
        "supports_3d_secure": 0,
        "is_deprecated": false,
        "additional_fields": ""
      },
      "orbital_salem": {
        "name": "Chase Paymentech Orbital (Salem)",
        "id_description": "Username (optional)",
        "test_id": "",
        "key_description": "Password (optional)",
        "test_key": "",
        "third_party_key_description": "Merchant ID",
        "test_third_party_key": "",
        "supports_auth_only": 1,
        "supports_multi_currency": false,
        "supports_3d_secure": 0,
        "is_deprecated": false,
        "additional_fields": {
          "blocks": [
            {
              "id": "orbital_additonal_fields",
              "parent_id": "gateway_live",
              "fields": [
                {
                  "id": "terminal_id",
                  "name": "Terminal ID",
                  "type": "text",
                  "default_value": "001",
                  "description": "If you don't know the exact value, leave it blank"
                }
              ],
              "is_live": true
            },
            {
              "id": "test_orbital_additional_fields",
              "parent_id": "gateway_test",
              "fields": [
                {
                  "id": "test_terminal_id",
                  "name": "Test Terminal ID",
                  "type": "text",
                  "default_value": "001",
                  "description": "If you don't know the exact value, leave it blank"
                }
              ],
              "is_live": false
            }
          ]
        }
      },
      ...
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers/payment_gateways">
  <link rel="self" href="https://api.foxycart.com/property_helpers/payment_gateways" title="List of supported Payment Gateways and valid entries for that resource&amp;#039;s type setting."/>
  <link rel="https://api.foxycart.com/rels/property_helpers" href="https://api.foxycart.com/property_helpers" title="Property Helpers Home"/>
  <message>The key values listed here are the correct values for the PaymentGateway type field. It also includes all of the additional default values for a payment gateway.</message>
  <values>
    <authorize>
      <name>Authorize.net</name>
      <id_description>API ID</id_description>
      <test_id>BxFSnPy7</test_id>
      <key_description>Transaction Key</key_description>
      <test_key>8SPBTpqs4uf2ZwM8</test_key>
      <third_party_key_description></third_party_key_description>
      <test_third_party_key></test_third_party_key>
      <supports_auth_only>1</supports_auth_only>
      <supports_multi_currency>false</supports_multi_currency>
      <supports_3d_secure>0</supports_3d_secure>
      <is_deprecated>false</is_deprecated>
      <additional_fields></additional_fields>
    </authorize>
    <orbital_salem>
      <name>Chase Paymentech Orbital (Salem)</name>
      <id_description>Username (optional)</id_description>
      <test_id></test_id>
      <key_description>Password (optional)</key_description>
      <test_key></test_key>
      <third_party_key_description>Merchant ID</third_party_key_description>
      <test_third_party_key></test_third_party_key>
      <supports_auth_only>1</supports_auth_only>
      <supports_multi_currency>false</supports_multi_currency>
      <supports_3d_secure>0</supports_3d_secure>
      <is_deprecated>false</is_deprecated>
      <additional_fields>
        <blocks>
          <id>orbital_additonal_fields</id>
          <parent_id>gateway_live</parent_id>
          <fields>
            <id>terminal_id</id>
            <name>Terminal ID</name>
            <type>text</type>
            <default_value>001</default_value>
            <description>If you don&amp;#039;t know the exact value, leave it blank</description>
          </fields>
          <is_live>true</is_live>
        </blocks>
        <blocks>
          <id>test_orbital_additional_fields</id>
          <parent_id>gateway_test</parent_id>
          <fields>
            <id>test_terminal_id</id>
            <name>Test Terminal ID</name>
            <type>text</type>
            <default_value>001</default_value>
            <description>If you don&amp;#039;t know the exact value, leave it blank</description>
          </fields>
          <is_live>false</is_live>
        </blocks>
      </additional_fields>
    </orbital_salem>
    ...
  </values>
</resource>

{
  "properties": {
      "message": "The key values listed here are the correct values for the PaymentGateway type field. It also includes all of the additional default values for a payment gateway.",
      "values": {
        "authorize": {
          "name": "Authorize.net",
          "id_description": "API ID",
          "test_id": "BxFSnPy7",
          "key_description": "Transaction Key",
          "test_key": "8SPBTpqs4uf2ZwM8",
          "third_party_key_description": "",
          "test_third_party_key": "",
          "supports_auth_only": 1,
          "supports_multi_currency": false,
          "supports_3d_secure": 0,
          "is_deprecated": false,
          "additional_fields": ""
        },
        "orbital_tampa": {
            "name": "Chase Paymentech Orbital (Tampa)",
            "id_description": "Username (optional)",
            "test_id": "",
            "key_description": "Password (optional)",
            "test_key": "",
            "third_party_key_description": "Merchant ID",
            "test_third_party_key": "",
            "supports_auth_only": 1,
            "supports_multi_currency": false,
            "supports_3d_secure": 0,
            "is_deprecated": false,
            "additional_fields": {
                "blocks": [
                    {
                        "id": "orbital_additonal_fields",
                        "parent_id": "gateway_live",
                        "fields": [
                            {
                                "id": "terminal_id",
                                "name": "Terminal ID",
                                "type": "text",
                                "default_value": "001",
                                "description": "If you don't know the exact value, leave it blank"
                            }
                        ],
                        "is_live": true
                    },
                    {
                        "id": "test_orbital_additional_fields",
                        "parent_id": "gateway_test",
                        "fields": [
                            {
                                "id": "test_terminal_id",
                                "name": "Test Terminal ID",
                                "type": "text",
                                "default_value": "001",
                                "description": "If you don't know the exact value, leave it blank"
                            }
                        ],
                        "is_live": false
                    }
                ]
            }
        },
        ...
      }
  },
  "links": [
      {
          "rel": [
              "self"
          ],
          "href": "https://api.foxycart.com/property_helpers/payment_gateways"
      },
      {
          "rel": [
              "https://api.foxycart.com/rels/property_helpers"
          ],
          "href": "https://api.foxycart.com/property_helpers"
      }
  ]
}

Zoomable Resources

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