paymentProviderDisable mutation

Version unstable

Disables a payment provider.

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
details ( String )

More details on why the merchant is disabling the payment provider.

id ( ID! ) required

The ID of the payment provider to disable.

reason ( PaymentProviderDisableReason )

The reason merchant is disabling the payment provider.

Return fields

  • disabledPaymentProviderId (ID)

    The global id of the disabled payment provider.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Disables a payment provider.

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
details ( String )

More details on why the merchant is disabling the payment provider.

id ( ID! ) required

The ID of the payment provider to disable.