payment_gateway

Collection: payment_gateways

A payment gateway stores the account information for your payment card gateway processor. You can assign a single payment gateway to a payment method set which controls if the processor is in live or in test mode.

To create a payment gateway, POST to the payment_gateways link relationship of a store. When creating a payment_method_set you can then use the payment_gateway_uri from the self link relationship of this resource.

Required Scopes

Full store_full_access
Read payment_settings_read
Write payment_settings_write

Actions

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

Properties (17)

description String · max 100

Description of this payment gateway.

Default: the gateway name

type String · Required

Valid payment gateway type. See the payment_gateways property helper for supported values.

use_auth_only Boolean

Set this to true if you want to only authorize payments through this gateway, and not capture any funds. Payments that are only authorized will need to be manually captured to actually take the funds from the customer.

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.

card_verification String

Your payment gateway card verification setting. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper card_verification_description field.

disabledenabled_automaticallyenabled_override
card_verification_config String · Optional

JSON configuration for card verification amounts by credit card type. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper card_verification_config_description field.

Stringified JSON config with default amount for different CC types.

test_card_verification String

Your test payment gateway card verification setting. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper card_verification_description field.

disabledenabled_automaticallyenabled_override
test_card_verification_config String · Optional

JSON configuration for test card verification amounts by credit card type. To view the specific description of this field for the given payment gateway, see the payment_gateways property helper card_verification_config_description field.

Stringified JSON config with default amount for different CC types.

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.

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.

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

self This Payment Gateway
fx:store GET PATCH PUT DELETE This Store
fx:payment_method_sets GET POST Payment method sets using this gateway.
https://api.foxycart.com/payment_gateways/{id}
Available via fx:payment_gateway on payment_method_set

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/payment_gateways/123",
      "title": "This 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?gateway_id=123",
      "title": "Payment method sets using this gateway."
    }
  },
  "description": "Default Payment Gateway",
  "type": "authorize",
  "use_auth_only": false,
  "account_id": "",
  "account_key": "",
  "third_party_key": "",
  "card_verification": "",
  "card_verification_config": "",
  "config_3d_secure": "",
  "additional_fields": "",
  "test_account_id": "BxFSnPy7",
  "test_account_key": "8SPBTpqs4uf2ZwM8",
  "test_third_party_key": "",
  "test_card_verification": "",
  "test_card_verification_config": "",
  "date_created": "2014-07-17T06:46:00-0700",
  "date_modified": "2014-07-17T06:46:00-0700"
}