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

PaymentProvider object

Version unstable

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • discountedTransactionFeeEndedAt (DateTime)

    Discount transaction fee end date for the shop on trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • paypalExpressAvailable (Boolean!)

    Does the provider offer the PayPal express option.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

  • expressAvailable (Boolean!) deprecated

    Does the provider offer an express option.

    Deprecation warning

    Use paypalExpressAvailable instead

Version unstable

An auto-generated type for paginating through multiple PaymentProviders.

Fields

Types that return PaymentProvider

Mutations for PaymentProvider

Version unstable

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProvider

Mutations for PaymentProvider

Version 2021-07 (Release candidate)

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2021-07 (Release candidate)

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2021-04 (Latest)

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2021-04 (Latest)

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2021-04 (Latest)

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2021-01

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2021-01

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2021-01

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2020-10

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2020-10

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2020-10

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2020-07

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2020-07

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2020-07

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2020-04

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2020-04

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2020-04

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2020-01 (Unsupported)

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2020-01 (Unsupported)

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2020-01 (Unsupported)

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2019-10 (Unsupported)

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2019-10 (Unsupported)

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2019-10 (Unsupported)

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2019-07 (Unsupported)

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2019-07 (Unsupported)

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2019-07 (Unsupported)

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge

Version 2019-04 (Unsupported)

Represents payment providers.

Required access

read_payment_settings access scope.

Fields

  • attachment (String)

    Label for the attachment field.

  • available (Boolean!)

    Is the provider available in the shop's country.

  • canRefund (Boolean!)

    Whether the provider accepts refunds.

  • Provider configuration for this shop.

  • countries ([CountryCode!]!)

    Supported countries of the provider.

  • Labels for credentials fields.

  • discountedTransactionFee (Float!)

    Discounted transaction fee while the shop is in trial.

  • eligible (Boolean!)

    Is the shop eligible for the provider.

  • group (ProviderGroup!)

    The group of the provider.

  • id (ID!)

    Globally unique identifier.

  • kind (String!)

    The kind of provider.

  • name (String!)

    The display name of the provider.

  • onboardingParams (JSON)

    Onboarding key-value parameters for the onboarding flow for this provider.

  • paymentMethods ([PaymentMethod!]!)

    The payment methods of the provider.

  • testModeAvailable (Boolean!)

    Does the provider offer a test mode.

  • transactionFee (Float!)

    Transaction fee for the provider.

  • url (URL)

    The URL of the provider.

Types that return PaymentProvider

Mutations for PaymentProvider

Implements

Deprecated fields

  • discountedTransactionFeeEndAt (DateTime!) deprecated

    Discount transaction fee end date for the shop on trial.

    Deprecation warning

    Not supported anymore.

Version 2019-04 (Unsupported)

An auto-generated type for paginating through multiple PaymentProviders.

On this page

Fields

Version 2019-04 (Unsupported)

An auto-generated type which holds one PaymentProvider and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of PaymentProviderEdge.

Types that return PaymentProviderEdge