Choose a version:

PaymentsAppConfiguration

object

Requires read_payment_gateways access scope.

The production configuration of the payments app.

Anchor to FieldsFields

Anchor to externalHandleexternalHandle •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.
Anchor to readyready •Boolean! non-null: Whether the provider is ready to process the merchant's payments.
Anchor to redirectUrlredirectUrl •URL! non-null: The URL that redirects the merchant to the configured gateway's settings page.

Was this section helpful?

Anchor to MutationsMutations

Anchor to paymentsAppConfigure paymentsAppConfigure

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

Show payload

Anchor to externalHandleexternalHandle •String: Handle used in the external system.
Anchor to gatewayReferencegatewayReference •String: The signed reference for the gateway being configured. Required when more than one current gateway configuration exists for the payments app on the shop.
Anchor to readyready •Boolean! required: The provider is ready to process merchant's payments.

Was this section helpful?

Anchor to FieldsFields

Anchor to MutationsMutations

Arguments