payment_method_set
Description
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.
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
- 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
| Property | Description | Type | Constraints |
|---|---|---|---|
| gateway_uri | The full API URI of the payment_gateway associated with this payment method set. | URL | Obtained from the self link relation of a payment_gateway. |
| description | The description of your payment method set. | String | Required. 100 characters or less. Defaults to Default Payment Method Set. |
| is_live | 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. | Boolean | true or false, 1 or 0. |
| is_purchase_order_enabled | 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. | Boolean | true or false, 1 or 0. |
| 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_sets/6",
"title": "Default Payment Method Set"
},
"fx:store": {
"href": "https://api-sandbox.foxycart.com/stores/8",
"title": "This Store"
},
"fx:payment_method_sets": {
"href": "https://api-sandbox.foxycart.com/stores/8/payment_method_sets",
"title": "Payment method sets for this store."
},
"fx:payment_gateway": {
"href": "https://api-sandbox.foxycart.com/payment_gateways/6",
"title": "Payment gateway for this payment method set."
},
"fx:payment_method_set_hosted_payment_gateways": {
"href": "https://api-sandbox.foxycart.com/payment_method_sets/6/hosted_payment_gateways",
"title": "Payment Method Set Hosted Payment Gateways relationships."
},
"fx:payment_method_set_fraud_protections": {
"href": "https://api-sandbox.foxycart.com/payment_method_sets/6/fraud_protections",
"title": "Payment Method Set Fraud Protection relationships."
}
},
"_embedded": {
"fx:payment_gateway": {
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/payment_gateways/6",
"title": "Default Payment Gateway"
},
"fx:store": {
"href": "https://api.foxycart.com/stores/8",
"title": "This Store"
},
"fx:payment_method_sets": {
"href": "https://api.foxycart.com/stores/8/payment_method_sets?gateway_id=6",
"title": "Payment method sets using this gateway."
}
},
"description": "Default Payment Gateway",
"type": "",
"hosted": false,
"use_auth_only": false,
"account_id": "",
"account_key": "",
"third_party_key": "",
"config_3d_secure": "",
"additional_fields": "",
"test_account_id": "",
"test_account_key": "",
"test_third_party_key": "",
"date_created": "2012-08-10T11:58:54-0700",
"date_modified": "2012-08-10T11:58:54-0700"
}
},
"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"
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/payment_method_sets/6" rel="https://api.foxycart.com/rels/payment_method_set">
<link rel="self" href="https://api-sandbox.foxycart.com/payment_method_sets/6" title="Default Payment Method Set"/>
<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_sets" href="https://api-sandbox.foxycart.com/stores/8/payment_method_sets" title="Payment method sets for this store."/>
<link rel="https://api.foxycart.com/rels/payment_gateway" href="https://api-sandbox.foxycart.com/payment_gateways/6" title="Payment gateway for this payment method set."/>
<link rel="https://api.foxycart.com/rels/payment_method_set_hosted_payment_gateways" href="https://api-sandbox.foxycart.com/payment_method_sets/6/hosted_payment_gateways" title="Payment Method Set Hosted Payment Gateways relationships."/>
<link rel="https://api.foxycart.com/rels/payment_method_set_fraud_protections" href="https://api-sandbox.foxycart.com/payment_method_sets/6/fraud_protections" title="Payment Method Set Fraud Protection relationships."/>
<resource href="https://api.foxycart.com/payment_gateways/6" rel="https://api.foxycart.com/rels/payment_gateway">
<link rel="self" href="https://api.foxycart.com/payment_gateways/6" title="Default Payment Gateway"/>
<link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/8" title="This Store"/>
<link rel="https://api.foxycart.com/rels/payment_method_sets" href="https://api.foxycart.com/stores/8/payment_method_sets?gateway_id=6" title="Payment method sets using this gateway."/>
<description>Default Payment Gateway</description>
<type></type>
<hosted>false</hosted>
<use_auth_only>false</use_auth_only>
<account_id></account_id>
<account_key></account_key>
<third_party_key></third_party_key>
<config_3d_secure></config_3d_secure>
<additional_fields></additional_fields>
<test_account_id></test_account_id>
<test_account_key></test_account_key>
<test_third_party_key></test_third_party_key>
<date_created>2012-08-10T11:58:54-0700</date_created>
<date_modified>2012-08-10T11:58:54-0700</date_modified>
</resource>
<gateway_uri>https://api-sandbox.foxycart.com/payment_gateways/6</gateway_uri>
<description>Default Payment Method Set</description>
<is_live>false</is_live>
<is_purchase_order_enabled>false</is_purchase_order_enabled>
<date_created>2012-08-10T11:58:54-0700</date_created>
<date_modified>2012-08-10T11:58:54-0700</date_modified>
</resource>
{
"class": [
"payment_method_set"
],
"properties": {
"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"
},
"entities": [
{
"class": [
"payment_gateway"
],
"rel": [
"https://api.foxycart.com/rels/payment_gateway"
],
"properties": {
"description": "Default Payment Gateway",
"type": "",
"hosted": false,
"use_auth_only": false,
"account_id": "",
"account_key": "",
"third_party_key": "",
"config_3d_secure": "",
"additional_fields": "",
"test_account_id": "",
"test_account_key": "",
"test_third_party_key": "",
"date_created": "2012-08-10T11:58:54-0700",
"date_modified": "2012-08-10T11:58:54-0700"
},
"links": [
{
"rel": [
"self"
],
"href": "https://api.foxycart.com/payment_gateways/6"
},
{
"rel": [
"https://api.foxycart.com/rels/store"
],
"href": "https://api.foxycart.com/stores/8"
},
{
"rel": [
"https://api.foxycart.com/rels/payment_method_sets"
],
"href": "https://api.foxycart.com/stores/8/payment_method_sets?gateway_id=6"
}
]
}
],
"links": [
{
"rel": [
"self"
],
"href": "https://api-sandbox.foxycart.com/payment_method_sets/6"
},
{
"rel": [
"https://api.foxycart.com/rels/store"
],
"href": "https://api-sandbox.foxycart.com/stores/8"
},
{
"rel": [
"https://api.foxycart.com/rels/payment_method_sets"
],
"href": "https://api-sandbox.foxycart.com/stores/8/payment_method_sets"
},
{
"rel": [
"https://api.foxycart.com/rels/payment_gateway"
],
"href": "https://api-sandbox.foxycart.com/payment_gateways/6"
},
{
"rel": [
"https://api.foxycart.com/rels/payment_method_set_hosted_payment_gateways"
],
"href": "https://api-sandbox.foxycart.com/payment_method_sets/6/hosted_payment_gateways"
},
{
"rel": [
"https://api.foxycart.com/rels/payment_method_set_fraud_protections"
],
"href": "https://api-sandbox.foxycart.com/payment_method_sets/6/fraud_protections"
}
]
}
Zoomable Resources
This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.