paymentProviderCreate mutation

Version unstable

Creates 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.


Argument Description
churnReason ( PaymentProviderChurnReasonInput )

The churn reason.

configuration ( PaymentProviderConfigurationInput! ) required

The payment provider configuration params.

enableExpress ( Boolean )

Whether express is enabled.
Default value: false

id ( ID! ) required

The ID of the payment provider to create.

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