Configure payment methods
Learn how to preselect, order, or hide payment methods using FastSpring checkout configuration and the Store Builder Library (SBL).
FastSpring supports multiple strategies for influencing how payment methods appear during checkout. You can preselect one method, control display order, hide specific methods, or allow-list only the ones you want buyers to use.
The sections below explain each configuration strategy, show supported parameters, and help you understand which combinations are allowed. Select a section or use the TOC on the right to jump ahead.
Prerequisites
Confirm requirements before configuring methods
How it works
Understand how payment controls are applied
Summary table
See common configuration options
Supported parameters
Learn what each field controls
Valid values
Accepted payment method identifiers
Configuration options
Preselect, reorder, or hide methods
Compatibility matrix
Valid and invalid parameter combinations
Error handling
Understand common validation errors
Behavior by checkout display mode
Compare Inline and Stacked behavior
Examples
Full SBL configuration examples
FAQs
Common questions
Prerequisites
Before configuring payment methods, make sure you have:
- A FastSpring checkout (Popup or Embedded) configured in your store
- Familiarity with the FastSpring Store Builder Library (SBL)
- At least one payment method enabled and supported for your target region and currency
Note on checkout terminology: When discussing payment controls, we use Inline and Stacked checkout to describe layout display modes. Popup checkout always uses the Inline mode, while Embedded checkout can be configured for either Inline or Stacked display. Visit our Compare payment method layouts documentation to learn more.
How it works
Payment method behavior is controlled by four SBL parameters:
paymentMethodpreselects a method in the Inline checkout.paymentMethodOrderdefines display order.hideOtherPaymentMethodsshows only the specified methods (allow-list mode).hidePaymentMethodshides selected methods from checkout.
FastSpring applies these settings together based on the buyer’s region, your store configuration, and product eligibility. Inline checkout may preselect a method, but Stacked checkout never does.
Summary table
Use this table to quickly identify which parameters to use based on the checkout behavior you want.
| Goal | Use these parameters | Notes |
|---|---|---|
| Preselect a payment method | paymentMethod | Inline checkout preselects the specified method when it is eligible and visible. Stacked checkout never preselects a method to ensure required legal notices remain visible on entry. |
| Order visible methods | paymentMethodOrder | Inline checkout follows your defined order and may preselect the first visible method. Stacked checkout reorders only accordion methods; express methods keep a fixed order and are not affected. |
| Show only one method | paymentMethod + hideOtherPaymentMethods=true | Checkout displays only the requested method. Inline may preselect it if eligible. Stacked displays the method but never preselects it, even when it is the only option. |
| Show only listed methods | paymentMethodOrder + hideOtherPaymentMethods=true | Only the methods in the list appear. Inline may preselect the first visible method. In Stacked checkout, both express and accordion methods are filtered by the list, but express methods retain their fixed order. |
| Hide specific methods | hidePaymentMethods | The listed methods are removed from checkout. All other eligible methods remain available. If a preselected method is hidden, checkout simply does not preselect and proceeds with the remaining methods. |
| Preselect + hide specific | paymentMethod + hidePaymentMethods | Inline attempts to preselect the specified method unless it is hidden. If the preselected method is in the hide list, it is removed, and no preselection occurs. Stacked never preselects, regardless of the method or hide list. |
Supported parameters
Use these parameters in your SBL configuration or secure payload to control how payment methods behave in checkout.
| Parameter | Description |
|---|---|
paymentMethod | Preselects a single payment method in Inline checkout when eligible and visible. Ignored in Stacked checkout. If this method is hidden through |
paymentMethodOrder | Sets the preferred display order for payment methods. Inline may preselect the first visible method. Stacked reorders accordion methods only, and express methods keep their fixed order. |
hideOtherPaymentMethods | Enables allow-list mode. Only the method specified in |
hidePaymentMethods | Hides specific methods from checkout. If the preselected method is hidden, no preselect occurs and checkout continues with the remaining methods. |
Valid payment method values
The table below lists the valid values for each supported payment method. Use these values in the paymentMethod and paymentMethodOrder fields, or as arguments to fastspring.builder.payment().
| Payment method | Value |
|---|---|
| ACH | ach |
| Alipay | alipay |
| Amazon Pay | amazon |
| Apple Pay | applepay |
| Credit/debit cards | card |
| Google Pay | googlepay |
| iDeal | ideal |
| KakaoPay | kakaopay |
| Klarna | klarna |
| MercadoPago | mercadopago |
| PayPal | paypal |
| Pix | pix |
| SEPA | sepa |
| UPI | upi |
| WeChat Pay | wechatpay |
| Wire Transfer | wire |
Configuration options
Below are common configuration options for controlling payment methods. Each option includes examples using both fastspring.builder.secure() and the payment directive where applicable.
Preselect one method and hide all others
Use this option when you want checkout to show only one payment method and prevent buyers from switching.
Preselect and hide all other methods using a secure payload.
fastspring.builder.secure({
"country": "DE",
"language": "en",
"items": [
{ "product": "virtuso-100-credits", "quantity": 2 }
],
"paymentMethod": "paypal",
"hideOtherPaymentMethods": true
});Result: In this example, only PayPal appears at checkout. Buyers cannot select any other payment method.
Notes:
- Do not combine
hideOtherPaymentMethodswithhidePaymentMethods. - The requested method must be eligible for the buyer’s region and currency.
Preselect one method and show other methods
Use this option when you want to recommend a method but still allow buyers to choose an alternative.
Preselect one method using a secure payload and leave all other eligible methods visible.
fastspring.builder.secure({
"country": "DE",
"language": "en",
"items": [
{ "product": "virtuso-100-credits", "quantity": 2 }
],
"paymentMethod": "paypal"
});Result: In this example, PayPal is preselected, and other eligible payment methods remain visible and selectable.
Notes:
- Do not include
hideOtherPaymentMethodsorhidePaymentMethods. - All other eligible methods remain available to the buyer.
Preselect one method and hide specific others
Use this option when you want to preselect a method but hide only specific alternatives.
fastspring.builder.secure({
"country": "DE",
"language": "en",
"items": [
{ "product": "virtuso-100-credits", "quantity": 2 }
],
"paymentMethod": "paypal",
"hidePaymentMethods": ["sepa", "wire", "klarna", "card"]
});Result: In this example, PayPal is preselected unless it appears in hidePaymentMethods. If the preselected method is hidden, checkout will not preselect a method, and all other eligible methods remain visible.
Notes:
hidePaymentMethodsaccepts an array of method identifiers.- Never use
hidePaymentMethodswithhideOtherPaymentMethods.
Compatibility matrix
| Primary parameter | paymentMethod | paymentMethodOrder | hidePaymentMethods | hideOtherPaymentMethods |
|---|---|---|---|---|
paymentMethod | — | |||
paymentMethodOrder | — | |||
hidePaymentMethods | — | |||
hideOtherPaymentMethods | — |
Note: Some valid combinations may return a 201 informational response. See Priority override in the Error handling section.
Error handling
FastSpring validates your configuration before checkout loads. If your request contains conflicting or unsupported settings, FastSpring returns a 400 error. In some cases, FastSpring may return an informational 201 response.
Priority override
Occurs when both paymentMethod and paymentMethodOrder are provided.
FastSpring prioritizes paymentMethod, ignores paymentMethodOrder, and returns a 201 informational response.
Conflicting parameters
Occurs when hidePaymentMethods and hideOtherPaymentMethods are sent together.
Message:
Conflicting request parameters: hidePaymentMethods and hideOtherPaymentMethods are mutually exclusive. Choose one.
Allow-list required
Occurs when hideOtherPaymentMethods=true is used without paymentMethod or paymentMethodOrder.
Message:
hideOtherPaymentMethods=true requires paymentMethodOrder or paymentMethod.
Unsupported for region
Occurs when all requested methods are unsupported for the buyer’s region.
Message:
Unsupported payment method(s) for this region. Use at least one supported for the buyer’s country.
Unsupported for store
Occurs when all requested methods are disabled at the store level.
Message:
Payment method(s) not enabled for this store. Enable them in settings or choose a different method.
Unsupported for product type
Occurs when none of the requested methods can be used for the product type.
Message:
Payment method not supported for this purchase. Update the request with a valid method.
Behavior by checkout display mode
Payment method behavior and parameter compatibility differ significantly across display modes.
Inline checkout
- User experience: Payment methods display horizontally at the top of the checkout form. All Popup checkouts use this display mode and is an option for Embedded checkouts.
- Behavior:
- Can preselect using
paymentMethod paymentMethodOrdercontrols order and may preselect the first visible methodhideOtherPaymentMethodsacts as an allow-listhidePaymentMethodshides specific methods. If the preselected method is hidden, checkout does not preselect
- Can preselect using
Stacked checkout
- User experience: Payment methods are presented as a vertically stacked list (accordion). When a buyer selects a method, its form details expand within the accordion directly on the same screen. This mode is only available for Embedded checkouts.
- Behavior:
- Never preselects a payment method
paymentMethodOrderreorders accordion methods only- Express methods maintain a fixed order
hideOtherPaymentMethodsacts as an allow-listhidePaymentMethodshides specific methods
Examples
Show only listed methods
Use this configuration when you want checkout to show only the methods you specify and hide everything else.
{
"paymentMethodOrder": ["card", "paypal", "applepay"],
"hideOtherPaymentMethods": true
}Order methods and hide one
Use this configuration when you want a specific method order but need to remove one or more methods.
{
"paymentMethodOrder": ["paypal", "amazonpay", "card"],
"hidePaymentMethods": ["googlepay"]
}Over-hide with fallback
This example shows how FastSpring falls back to the eligible set when too many methods are hidden without allow-list mode.
{
"hidePaymentMethods": ["card", "paypal", "applepay", "googlepay"],
"hideOtherPaymentMethods": false
}FAQs
Which payment methods can I preselect?
Any method supported for the buyer’s region and currency may be preselected in Inline checkout.
Can these settings be used with 1ClickPay?
Yes. 1ClickPay appears when card payments are available. If card is hidden or disabled, 1ClickPay is also hidden.
Does paymentMethodOrder change express methods?
No. In Stacked checkout, express methods follow a fixed order. The parameter only reorders accordion methods.
Can customers choose another method?
Yes. Unless you hide or allow-list methods, buyers can select any other supported method.
Do I need a specific SBL version?
Yes. Use the latest version of the FastSpring Store Builder Library to ensure all configuration options are supported.
Updated about 9 hours ago