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

shopifyPaymentsUpdate mutation

Version unstable

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

  • attachment (String)

    The attachment for the provider.

  • Payment provider credentials provided by the merchant.

  • enabledCurrencies ([CurrencyCode!])

    The enabled presentment currencies.

  • expressEnabled (Boolean)

    Whether express is enabled.

  • extraSettings ([AttributeInput!])

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

  • instructions (String)

    The instructions for a manual provider.

  • message (String)

    The additional details to display to the user on the payment page.

  • The updated list of payment methods.

  • paypalExpressEnabled (Boolean)

    Whether PayPal express is enabled.

  • testModeEnabled (Boolean)

    Whether the merchant has enabled test mode.

  • threeDSecureSetting (ThreeDSecureSetting)

    The 3DS setting for the provider.

Return fields

Version 2021-07 (Release candidate)

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2021-04 (Latest)

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2021-01

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2020-10

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2020-07

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2020-04

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2020-01 (Unsupported)

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2019-10 (Unsupported)

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2019-07 (Unsupported)

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields

Version 2019-04 (Unsupported)

Updates the Shopify Payments account and gateway properties.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
account ( ShopifyPaymentsAccountInput! ) required

The Shopify Payments account properties.

configuration ( PaymentProviderConfigurationInput )

The payment provider configuration params, such as the payment methods, credentials or activation of the test mode.

id ( ID! ) required

The ID of the payment provider to update.

options ( PaymentProviderOptionsInput )

The payment provider update options, such as the fraud and notification settings.

PaymentProviderConfigurationInput fields

Return fields