payment_method_set_hosted_payment_gateway

Collection: payment_method_set_hosted_payment_gateways

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.

Required Scopes

Full store_full_access
Read payment_settings_read
Write payment_settings_write

Actions

GET View a payment method set hosted payment gateway relationship
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 relationship
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (4)

payment_method_set_uri String

The full API URI of the payment method set associated with this payment method set hosted payment gateway.

Obtained from the self link relation of a payment_method_set.

hosted_payment_gateway_uri String

The full API URI of the hosted payment gateway associated with this payment method set hosted payment gateway.

Obtained from the self link relation of a hosted_payment_gateway.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (4)

self Payment Method Set Hosted Payment Gateway Relationship
fx:store GET PATCH PUT DELETE This Store
fx:payment_method_set GET PATCH PUT DELETE This Payment Method Set
fx:hosted_payment_gateway GET PATCH PUT DELETE This Hosted Payment Gateway
https://api.foxycart.com/payment_method_set_hosted_payment_gateways/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/payment_method_set_hosted_payment_gateways/123",
      "title": "Payment Method Set Hosted Payment Gateway Relationship"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:payment_method_set": {
      "href": "https://api.foxycart.com/payment_method_sets/999",
      "title": "This Payment Method Set"
    },
    "fx:hosted_payment_gateway": {
      "href": "https://api.foxycart.com/hosted_payment_gateways/999",
      "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"
}