Skip to main content
Anchor to PaymentsAppConfiguration

PaymentsAppConfiguration

object

Requires read_payment_gateways access scope.

The production configuration of the payments app.

•String

A username or identifier associated with the account that the merchant has used with the partner. It displays in the Payments section in the Shopify admin. The externalHandle enables the merchant to identify the connected payment provider account.

•Boolean!
non-null

Whether the provider is ready to process the merchant's payments.


Was this section helpful?

•mutation

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.


Was this section helpful?