payment_method_set_hosted_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_method_set_hosted_payment_gateways
POST
Create a new payment_method_set_hosted_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_method_set_hosted_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_method_set_hosted_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_method_set_hosted_payment_gateway

Description

This resource represents a relationship between a payment method set and a hosted payment gateway. To add a hosted payment gateway to a payment method set, you create a payment method set hosted payment gateway resource by sending a POST to the payment_method_set_hosted_payment_gateways link relationship of a payment_method_set using the hosted_payment_gateway uri from its self link relationship.

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_method_set_hosted_payment_gateway
PATCH
Update a payment_method_set_hosted_payment_gateway (send only the properties you want to modify)
PUT
Replace a payment_method_set_hosted_payment_gateway (send the entire representation)
DELETE
Delete a payment_method_set_hosted_payment_gateway
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
payment_method_set_uri The full API URI of the payment method set associated with this payment method set hosted payment gateway. URL Obtained from the self link relation of a payment_method_set.
hosted_payment_gateway_uri The full API URI of the hosted payment gateway associated with this payment method set hosted payment gateway. URL Obtained from the self link relation of a hosted_payment_gateway.
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_method_set_hosted_payment_gateways/2",
            "title": "Payment Method Set Hosted Payment Gateway Relationship"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/8",
            "title": "This Store"
        },
        "fx:payment_method_set": {
            "href": "https://api-sandbox.foxycart.com/payment_method_sets/6",
            "title": "This Payment Method Set"
        },
        "fx:hosted_payment_gateway": {
            "href": "https://api-sandbox.foxycart.com/hosted_payment_gateways/390",
            "title": "This Hosted Payment Gateway"
        }
    },
    "payment_method_set_uri": "https://api-sandbox.foxycart.com/payment_method_sets/6",
    "hosted_payment_gateway_uri": "https://api-sandbox.foxycart.com/hosted_payment_gateways/390",
    "date_created": "2015-05-26T17:51:08-0700",
    "date_modified": "2015-05-26T17:51:08-0700"
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/payment_method_set_hosted_payment_gateways/2" rel="https://api.foxycart.com/rels/payment_method_set_hosted_payment_gateway">
  <link rel="self" href="https://api-sandbox.foxycart.com/payment_method_set_hosted_payment_gateways/2" title="Payment Method Set Hosted Payment Gateway Relationship"/>
  <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_set" href="https://api-sandbox.foxycart.com/payment_method_sets/6" title="This Payment Method Set"/>
  <link rel="https://api.foxycart.com/rels/hosted_payment_gateway" href="https://api-sandbox.foxycart.com/hosted_payment_gateways/390" title="This Hosted Payment Gateway"/>
  <payment_method_set_uri>https://api-sandbox.foxycart.com/payment_method_sets/6</payment_method_set_uri>
  <hosted_payment_gateway_uri>https://api-sandbox.foxycart.com/hosted_payment_gateways/390</hosted_payment_gateway_uri>
  <date_created>2015-05-26T17:51:08-0700</date_created>
  <date_modified>2015-05-26T17:51:08-0700</date_modified>
</resource>
{
    "class": [
        "payment_method_set_hosted_payment_gateway"
    ],
    "properties": {
        "payment_method_set_uri": "https://api-sandbox.foxycart.com/payment_method_sets/6",
        "hosted_payment_gateway_uri": "https://api-sandbox.foxycart.com/hosted_payment_gateways/390",
        "date_created": "2015-05-26T17:51:08-0700",
        "date_modified": "2015-05-26T17:51:08-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/payment_method_set_hosted_payment_gateways/2"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/8"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/payment_method_set"
            ],
            "href": "https://api-sandbox.foxycart.com/payment_method_sets/6"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/hosted_payment_gateway"
            ],
            "href": "https://api-sandbox.foxycart.com/hosted_payment_gateways/390"
        }
    ]
}

Zoomable Resources

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