API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

PaymentProviderConfiguration object

Version unstable

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • paypalExpressActivated (Boolean!)

    Does the provider have the PayPal express option activated.

  • paypalExpressActivationStatus (PaypalExpressActivationStatus!)

    PayPal express activation state.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Deprecated fields

  • expressEnabled (Boolean) deprecated

    Whether express is enabled.

    Deprecation warning

    Use paypalExpressActivationStatus instead

  • paypalExpressEnabled (Boolean) deprecated

    Whether PayPal express is enabled.

    Deprecation warning

    Use paypalExpressActivationStatus instead

Version 2021-07 (Release candidate)

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2021-04 (Latest)

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2021-01

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2020-10

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2020-07

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2020-04

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2020-01 (Unsupported)

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2019-10 (Unsupported)

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2019-07 (Unsupported)

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements

Version 2019-04 (Unsupported)

Holds all payment provider configuration information.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    The attachment for the gateway.

  • Payment provider credentials provided by the merchant.

  • currencies ([CurrencySetting!]!)

    The enabled presentment currency settings.

  • enabled (Boolean!)

    The status of the gateway.

  • extraSettings ([Attribute!]!)

    Extra settings for the gateway such as checkboxes or radio buttons.

  • id (ID!)

    Globally unique identifier.

  • instructions (String)

    The instructions for the manual or custom gateway.

  • message (String)

    The message for the manual or custom gateway.

  • multiCurrencySupported (Boolean!)

    Whether or not multi currency is supported.

  • Payment methods that are active.

  • testModeEnabled (Boolean!)

    Status of test mode for the gateway.

  • threeDSecureSetting (ThreeDSecureSetting)

    3D Secure setting for the gateway.

Types that return PaymentProviderConfiguration

Implements