hosted_payment_gateways

Description

This property helper lets you know which hosted payment gateways we currently support. Hosted gateways are those which take the customer off the checkout page to a third party service to complete the transaction before returning back to the checkout or receipt.

The values JSON object has the following properties

  • name: The name of this hosted payment gateway.
  • id_description: The description of the id field for this hosted gateway.
  • test_id: The default id you can use for testing this hosted gateway.
  • key_description: The description of the key field for this hosted gateway.
  • test_key: The default key you can use for testing this hosted gateway.
  • third_party_key_description: The description of the third party key field for this hosted gateway.
  • test_third_party_key: The default third party key you can use for testing this hosted gateway.
  • supports_auth_only: Whether or not this hosted gateway supports authorize only instead of auth+capture.
  • card_verification: This value is using for verification, can have one of this value:
    "Disabled": Will never verify payment methods. Not recommended.
    "Enabled, automatically": Will perform a verification on zero-amount transactions when a payment method is required (such as future subscriptions). Greater than zero-amount transactions will be authorized or auth+captured at the full amount.
    "Always and only verify": For all transactions where a payment method is required (both zero-amount and greater than zero-amount), the payment method will be verified. Payment will not be collected without additional action. Only recommended in specific situations.
    In all cases, a payment method will not be required for "free" transactions, such as if a coupon brings the order total to zero.
  • card_verification_config: This setting configures what amount should be used when verifying the customers card, based on the card type. It should be a stringified valid JSON object, formatted like this (which is also the default value): {"verification_amounts": {"visa": 1, "mastercard": 1, "american_express": 1, "discover": 1, "default": 1}}
    Please check with your gateway or merchant account provider for these values, as some processors prefer different values.
  • supports_card_verification: Whether or not this gateway supports verification mode. 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_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.
  • config_3d_secure: For which types of CC supports 3D Secure functionality.
  • supports_3d_secure: Whether or not this hosted gateway supports 3D Secure functionality.
  • is_deprecated: True if this hosted gateway is deprecated and should no longer be used.
  • additional_fields: If this hosted gateway requires additional information, this will contain details about the data which needs to be collected to configure this hosted 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 hosted_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

{
  "message": "The values listed here are the various hosted_payment_gateways types supported. The values are listed in the format value => description.",
  "values": {
    "mollie_omnipay": {
      "name": "Mollie",
      "id_description": "Secret Key",
      "test_id": "test_w5QVbJ4cBWFJPq7fDk79TSAWsAn2GE",
      "key_description": "",
      "test_key": "",
      "third_party_key_description": "",
      "test_third_party_key": "",
      "supports_auth_only": true,
      "supports_3d_secure": false,
      "supports_multi_currency": true,
      "is_deprecated": false,
      "additional_fields": ""
    },
    ...
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers/hosted_payment_gateways">
  <link rel="self" href="https://api.foxycart.com/property_helpers/hosted_payment_gateways" title="Hosted Payment Gateways such as PayPal, BitPay, and Dwolla."/>
  <link rel="https://api.foxycart.com/rels/property_helpers" href="https://api.foxycart.com/property_helpers" title="Property Helpers Home"/>
  <message>The values listed here are the various hosted_payment_gateways types supported. The values are listed in the format value =&amp;gt; description.</message>
  <values>
    <mollie_omnipay>
      <name>Mollie</name>
      <id_description>Secret Key</id_description>
      <test_id>test_w5QVbJ4cBWFJPq7fDk79TSAWsAn2GE</test_id>
      <key_description></key_description>
      <test_key></test_key>
      <third_party_key_description></third_party_key_description>
      <test_third_party_key></test_third_party_key>
      <supports_auth_only>true</supports_auth_only>
      <supports_3d_secure>false</supports_3d_secure>
      <supports_multi_currency>true</supports_multi_currency>
      <additional_fields></additional_fields>
    </mollie_omnipay>
    ...
  </values>
</resource>

{
    "properties": {
        "message": "The values listed here are the various hosted_payment_gateways types supported. The values are listed in the format value => description.",
        "values": {
            "mollie_omnipay": {
                "name": "Mollie",
                "id_description": "Secret Key",
                "test_id": "test_w5QVbJ4cBWFJPq7fDk79TSAWsAn2GE",
                "key_description": "",
                "test_key": "",
                "third_party_key_description": "",
                "test_third_party_key": "",
                "supports_auth_only": true,
                "supports_3d_secure": false,
                "supports_multi_currency": true,
                "additional_fields": ""
            },
            ...
        }
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/property_helpers/hosted_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.