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

PaymentMethodConfiguration object

Version unstable

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2021-07 (Release candidate)

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2021-04 (Latest)

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2021-01

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2020-10

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2020-07

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2020-04

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2020-01 (Unsupported)

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2019-10 (Unsupported)

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2019-07 (Unsupported)

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration

Version 2019-04 (Unsupported)

Represents details of a payment method configuration.

Required access

read_payment_settings access scope.

Fields

  • capabilityParams (CapabilityParams)

    All information related to the capability related to the payment method.

  • enabled (Boolean!)

    Whether the payment method is enabled.

  • name (String!)

    Identifier for the payment method.

  • paymentExperienceConfigurationId (UnsignedInt64)

    The id of the payment experience configuration.

Types that return PaymentMethodConfiguration