Build payment customizations
You can use payment customizations to hide, reorder, and rename the payment options that are available to buyers during checkout. In this tutorial series, you'll use Shopify Functions to create a function that lets merchants hide a payment option offered to customers at checkout, based on the total value of their cart.
What you'll learn
Anchor link to section titled "What you'll learn"In this tutorial series, you'll learn how to do the following tasks:
- Set up your environment to use functions.
- Create a payment customization function.
- Add configuration to your payment customization using metafields.
- Build a payment customization user interface with App Bridge.
Requirements
Anchor link to section titled "Requirements"- You've created a Partner account.
- You've created a development store.
You've created an app that uses Shopify CLI 3.49.5 or higher. If you previously installed Shopify CLI, then make sure that you're using the latest version.
If you plan to create a UI for your extension, then start with the Remix app template.
You've installed Node.js 16 or higher.
You've installed your app on the development store.
Rust-specific requirements
Anchor link to section titled "Rust-specific requirements"The following requirements are specific to Rust-based development with Shopify Functions.
You've installed Rust.
On Windows, Rust requires the Microsoft C++ Build Tools. Make sure to select the Desktop development with C++ workload when installing the tools.
You've installed cargo-wasi:
Limitations and considerations
Anchor link to section titled "Limitations and considerations"- Plan and geographical restrictions apply. Learn more
- When the Payment Customization API usage is restricted, the function input will still contain all payment methods, however output operations that target restricted payment methods will not take effect on the checkout.
The Payment Customization API doesn't currently support draft orders.
You can't rename payment methods that have logos as a name, such as Shop Pay, Apple Pay and Google Pay. This also includes all wallets and the Shopify native gift card field.
In Shop Pay, payment customization functions do not apply operations on any payment methods except the native gift card field.
You can remove wallets from the Express or payment method section of checkout, but you can't reorder them.
You can install a maximum of five payment customization functions on each store.
Sample code
Anchor link to section titled "Sample code"If you want to quickly get started, then you can get the sample code by completing the following steps. The tutorial series describes the sample code step by step.
Clone the payment customizations sample app:
Enter a name for your app project.
Navigate to your app directory:
Link your app configuration:
Start a local server for your app:
With the server running, open the Preview URL in the terminal output.
When you open the URL, you're prompted to install the app on your development store.
Click Install app to install the app on the store.
Tutorial series
Anchor link to section titled "Tutorial series"Follow the tutorial series to go from "Hello World" to a functional payments customization experience.
Developer tools and resources
Anchor link to section titled "Developer tools and resources"Explore the following developer tools and resources to get familiar with building payment customizations.
- Get started with building payment customizations.