Skip to main content
Anchor to paymentsAppConfigure

paymentsAppConfigure

mutation

Requires write_payment_gateways access scope.

Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the paymentsAppConfigure mutation, refer to the tutorial for onboarding merchants to payments extensions.

Anchor to Arguments

Arguments

Anchor to externalHandleexternalHandle
•String

Handle used in the external system.

Anchor to readyready
•Boolean!required

The provider is ready to process merchant's payments.

Was this section helpful?

Anchor to PaymentsAppConfigurePayload returnsPaymentsAppConfigurePayload returns

Anchor to paymentsAppConfigurationpaymentsAppConfiguration
•PaymentsAppConfiguration

The production configuration of the payments app.

Anchor to userErrorsuserErrors
•[UserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?