payment_method_set

Collection: payment_method_sets

A Payment Method Set is where you configure your payment gateway and your hosted gateways as being in live or test mode and where you enable the pay by purchase order option for your store. It also links to your payment gateway settings and your enabled hosted payment gateways. By default, the linked payment_gateway resource is automatically embedded in the response.

Required Scopes

Full store_full_access

Read payment_settings_read

Write payment_settings_write

Actions

GET View a payment method set

PATCH Update a payment method set (send only the properties you want to modify)

PUT Replace a payment method set (send the entire representation)

DELETE Delete a payment method set

HEAD Get just the header response

OPTIONS Get a response explaining which HTTP methods are supported

Properties (6)

gateway_uri String

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

Obtained from the self link relation of a payment_gateway.

description String · Required · max 100

The description of your payment method set.

Default: Default Payment Method Set

is_live Boolean

Set this to true to enable a live payment gateway and live hosted gateways. This can only be set to true if your store is active. If this is set to false, transactions will be processed as test transactions.

is_purchase_order_enabled Boolean

Set this to true to enable the purchase order payment option on your store. This can only be set to true if your store is active.

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 (7)

self This Payment Method Set

fx:store GET PATCH PUT DELETE This Store

fx:payment_method_sets GET POST Payment method sets for this store.

fx:payment_gateway GET PATCH PUT DELETE Payment gateway for this payment method set.

fx:payment_method_set_hosted_payment_gateways GET POST Payment Method Set Hosted Payment Gateways relationships.

fx:payment_method_set_fraud_protections GET POST Payment Method Set Fraud Protection relationships.

fx:connect_gateway POST Use POST request to connect GW

Zoomable Resources

Embed related resources using ?zoom=<resource>. Filter with ?resource:property=value.

payment_gateway

https://api.foxycart.com/payment_method_sets/{id}

Available via fx:payment_method_set on payment·fx:payment_method_set on payment_method_set_fraud_protection·fx:payment_method_set on payment_method_set_hosted_payment_gateway·fx:payment_method_set on template_set

Example Representation

Show _links

Zoom

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/payment_method_sets/123",
      "title": "This Payment Method Set"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:payment_method_sets": {
      "href": "https://api.foxycart.com/stores/456/payment_method_sets",
      "title": "Payment method sets for this store."
    },
    "fx:payment_gateway": {
      "href": "https://api.foxycart.com/payment_gateways/456",
      "title": "Payment gateway for this payment method set."
    },
    "fx:payment_method_set_hosted_payment_gateways": {
      "href": "https://api.foxycart.com/payment_method_sets/123/hosted_payment_gateways",
      "title": "Payment Method Set Hosted Payment Gateways relationships."
    },
    "fx:payment_method_set_fraud_protections": {
      "href": "https://api.foxycart.com/payment_method_sets/123/fraud_protections",
      "title": "Payment Method Set Fraud Protection relationships."
    },
    "fx:connect_gateway": {
      "href": "https://api.foxycart.com/payment_method_sets/123/connect_gateway",
      "title": "Use POST request to connect GW"
    }
  },
  "gateway_uri": "https://api-sandbox.foxycart.com/payment_gateways/6",
  "description": "Default Payment Method Set",
  "is_live": false,
  "is_purchase_order_enabled": false,
  "date_created": "2012-08-10T11:58:54-0700",
  "date_modified": "2012-08-10T11:58:54-0700"
}