Manage payments app extensions
To enable payments capabilities for your app, you need to create, configure and publish a payments app extension to your app.
What you'll learn
Anchor link to section titled "What you'll learn"In this tutorial, you'll learn how to do the following tasks:
- Configure offsite and credit card payments app extensions.
- Submit your payments app extension for review.
- Publish a version of your payments app extension.
Requirements
Anchor link to section titled "Requirements"- You've applied and been approved to become a Payments Partner.
- You've created a Partner account and a development store.
- You understand how apps fit into Shopify and the different ways of distributing your app.
You've created an app that uses Shopify CLI 3.0 or higher, or you've migrated your existing app so that it's compatible with Shopify CLI 3.0 or higher.
You've disabled the embedded app configuration for your app in the Partner Dashboard.
Step 1: Create your payments app extension
Anchor link to section titled "Step 1: Create your payments app extension"- From your Partner Dashboard, click Apps.
- Click the name of the app that you want to change.
- Click Extensions.
- Click Create +.
- Select the Payments tab to create an offsite payments app extension or credit card payments app extension.
- Enter your extension name and select Create.
Step 2: Configure your payments app extension for submission
Anchor link to section titled "Step 2: Configure your payments app extension for submission"From the Extension settings page, click Open draft.
Configure the fields of the payments app extension, and then click Save draft.
Step 3: Submit your payments app extension
Anchor link to section titled "Step 3: Submit your payments app extension"After you've finished your draft, you can submit your payments app extension for review. You can use this same process to submit new versions of your payments app extension.
From the Extension details page, click Create version.
Select Minor or Major version.
Minor versions introduce changes that are backwards compatible. Major version changes aren't backwards compatible and might affect users who are currently using your extension.
Select Submit for Review.
Wait for Shopify to approve your submitted version of your payments app extension. For more information, refer to the payments app approval process.
While Shopify reviews your payments app extension, the version displays a Pending state:
After Shopify approves your payments app extension version, it's marked with Approved and Live tags:
Step 4: Publish a version of your payments app extension
Anchor link to section titled "Step 4: Publish a version of your payments app extension"After your payments app extension has been approved, you can publish it.
When you publish your payments app extension, the configuration of your payments app extension that you chose to publish becomes live. After the first payments app extension is published, the payments app extension can be used and tested.
- Select Publish beside the version that you want to publish.
- Click Publish in the popup modal to confirm.
Unpublishing a version of your payments app extension
Anchor link to section titled "Unpublishing a version of your payments app extension"Don't unpublish a version of your payments app extension. Instead, you should publish a different version of your payments app extension.
Unpublishing a version of your payments app extension invalidates the payments app provider. It breaks the payments app provider for stores that have it installed because the store tries to fetch a published version that no longer exists.
- Learn how to implement a payments app to process transactions.