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 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"In your extension draft page, configure the fields of the payments app extension, and then click Save draft. - List of configuration fields for an offsite payments app extension. - List of configuration fields for a credit card payments app extension.
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. Any changes that are made after publishing need to be approved by Shopify as a new version of the payments app extension.
For more information, refer to the payments app approval process.
Create an app version
Anchor link to section titled "Create an app version"To submit your app extension for review, you first need to create an app version. An app version is a snapshot of all of your app extensions.
- From the Partner Dashboard, go to Apps.
Select your app from the list.
Click Versions.
From the Versions page, click Create version.
Optional: enter a name and message for the version.
Click Create version.
Submit the app version for review
Anchor link to section titled "Submit the app version for review"- From the Partner Dashboard, go to Apps.
- Select your app from the list.
- Click Versions.
- Select the version that you want to release.
Click Submit for review.
When Shopify has reviewed and approved the app version, click Release to release the new app version to users.
Step 4: Release your approved app version
Anchor link to section titled "Step 4: Release your approved app version"After the version of your app that contains your payments app extension has been approved, you can release it. After release, the payments app extension can be used and tested.
Learn about managing app versions.
Don't delete your payments app extension from the Partner Dashboard. Instead, you should release a different version of your payments app extension.
Releasing a version of your app that doesn't contain the 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 an app extension that no longer exists.
- Learn how to implement a payments app to process transactions.