hosted_payment_gateways : Foxy hAPI

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.
supports_3d_secure: Whether or not this hosted gateway supports 3D Secure functionality.
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.

Sandbox Example

You can interact with this resource and run actions against the sandbox API via our HAL Brower.

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,
      "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>
      <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,
                "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.