Creating a payments app
A public app becomes a payments app after you've configured, submitted, and published your payments app extension for approval.
When you publish your payments app, your app becomes available in the Shopify App Store, and merchants can easily install and use the app across all Shopify stores.
This page guides you through configuring, submitting, and publishing a payments app extension.
Step 1: Configuring your payments app extension for submission
Before you can publish your payments app extension, you need to:
- Give your payments app extension a name
- Open a draft for your payments app extension
- Submit your payments app extension
Give your payments app extension a name
- 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 payment provider.
- Enter your extension name and select Save.
Open a draft for your payments app extension
From the Extension settings page, click Open draft.
Configure the fields of the Payments app extension. For more information, refer to Payments app extension configuration fields.
Click Save draft.
Payments app extension configuration fields
- Payment session URL: The URL that receives payment and order details from the checkout.
- Refund session URL: The URL that refund session requests are sent to.
- Capture session URL: The URL that capture session requests are sent to. This is only used if your payments app supports merchant manual capture or void payments.
- Void session URL: The URL that void session requests are sent to. This is only used if your payments app supports merchant manual capture or void payments.
- Payment methods: The payment methods (for example, Visa) that are available with your payment provider app.
- Available countries: The countries where your payment provider app is available.
- Merchant admin name: The name for your payment provider app. This name is displayed to merchants in the Shopify admin when they search for payment methods to add to their store. Limited to 50 characters.
- Checkout name: Optional. The name of the checkout. Your checkout name can be the same as your Merchant admin name or it can be customized for customers. This name is displayed with the payment methods you support in the customer checkout. After a checkout name has been set, translations should be provided for localization.
- Test mode: Allows merchants using your payment provider app to test their setup by simulating transactions. To test your app on a development store, your alternative payment provider in the Shopify admin must be set to test mode.
- Buyer features: The customer features that your payment provider app offers. 3D Secure support is mandated in some instances. For example, you must select the 3D Secure buyer feature checkbox if you plan to support credit card payments in countries which have mandated 3D Secure.
- API Version: The API version used by the payment provider app. This determines which version is used for requests being sent to the app. Currently, all versions of the payments app schema send identical payloads.
Step 2: 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.
To create a new version of your payments app extension, follow the steps below:
From the Extension details page, click Create version.
Select Minor or Major version.
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 extension 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.
Payments app extension approval process
- The Partner applies to become a payment Partner.
- Shopify grants the payment Partner access to build a payments app.
- The Partner builds an app, and configures a payments app extension.
- The Partner submits the payments app extension for approval.
- Shopify approves the payments app extension.
- The Partner tests the payments app extension.
- The Partner submits the app.
- Shopify approves the app.
- The Partner launches the app.
- Optionally, the Partner reconfigures the payments app extension and submits a new version of the payments app extension.
Step 3: Publish a version of your payments app extension
After your payments app extension has been approved, you can publish it. Publishing makes your payments app extension available on the Shopify App Store, so merchants to use your payments app on their store.
To publish your new version:
- Select Publish for the version you'd like to publish.
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.