hosted_payment_gateway

Collection: hosted_payment_gateways

A hosted payment gateway is a checkout payment method which involves the customer being redirected to a third party payment service hosted page such as PayPal or Amazon. From there, customers login and use payment mechanisms configured within that service. Not every hosted payment gateway supports subscriptions.

To create a hosted payment gateway, POST to the hosted_payment_gateways link relationship of a store to configure your gateway credentials. Then, to enable this hosted payment gateway for your store, POST to the payment_method_set_hosted_payment_gateways link relationship of the payment method set you want to assign this hosted payment gateway to.

Required Scopes

Full store_full_access
Read payment_settings_read
Write payment_settings_write

Actions

GET View a hosted payment gateway
PATCH Update a hosted payment gateway (send only the properties you want to modify)
PUT Replace a hosted payment gateway (send the entire representation)
DELETE Delete a hosted payment gateway
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (16)

description String · max 100

Description of this payment gateway.

Default: the gateway name

type String · Required

Valid hosted payment gateway type.

account_id String · Optional · max 500

Your payment gateway account id. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper id_description field.

account_key String · Optional · max 1000

Your payment gateway account key. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper key_description field.

third_party_key String · Optional · max 500

Your payment gateway third party key. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper third_party_key_description field.

config_3d_secure String

Configuration settings for 3D Secure.

""all_cardsmaestro_onlyall_cards_require_valid_responsemaestro_only_require_valid_response
additional_fields String · Optional · max 1000

Additional configuration details specific to each payment gateway.

card_verification String

Live card verification setting if supported by this gateway.

disabledenabled_automaticallyenabled_override
card_verification_config String · Optional

JSON serialized string with verification amounts per card type.

test_account_id String · Optional · max 500

Your test payment gateway account id. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper id_description field.

test_account_key String · Optional · max 1000

Your test payment gateway account key. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper key_description field.

test_third_party_key String · Optional · max 500

Your test payment gateway third party key. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper third_party_key_description field.

test_card_verification String

Test card verification setting if supported by this gateway.

disabledenabled_automaticallyenabled_override
test_card_verification_config String · Optional

JSON serialized string with test verification amounts per card type.

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 This Hosted Payment Gateway
fx:store GET PATCH PUT DELETE This Store
fx:payment_method_sets GET POST Payment Method Sets for this store
fx:connect_gateway POST Use POST request to generate reconnect gateway URL.

Only present when the hosted payment gateway type supports gateway connection.

https://api.foxycart.com/hosted_payment_gateways/{id}
Available via fx:hosted_payment_gateway on payment_method_set_hosted_payment_gateway

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/hosted_payment_gateways/123",
      "title": "This Hosted Payment Gateway"
    },
    "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"
    }
  },
  "description": "Amazon",
  "type": "amazon_mws",
  "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": "2015-05-26T17:49:56-0700",
  "date_modified": "2015-05-26T17:49:56-0700"
}