In Solidus, each
Spree::PaymentMethod represents one way that your store
chooses to accept payments. For example, you may want to set up separate payment
methods for PayPal payments and credit card payments.
You can inherit the
Spree::PaymentMethod base class
when you build your own integration for a payment service provider. <!-- For
more information about Solidus and payment service providers, see the
Spree::PaymentMethod objects have the following attributes:
type: The subclass of
Spree::PaymentMethodthat this payment method represents.
name: The display name for this payment method.
description: The description for this payment method.
auto_capture: Determines whether a payment should be captured (
true) or only authorized (
false) during payment processing. For more information, see Auto-capture .
preferences: A hash of preferences and their current settings for the current payment method. The available preferences can be changed by setting a different
preference_source: Sets the source for the
preferenceshash content. Your payment method may require additional preferences for interfacing with a payment service provider. See Preferences for more information.
active: Sets whether the payment method is active. Set this to
falseto hide the payment method from customers.
available_to_users: Determines if the payment method is visible to users.
available_to_admin: Determines if the payment method is visible to administrators.
Each payment method has a
preferences attribute that stores settings as a
hash. The preference values get passed to the payment service provider, so your
payment method may require additional preferences (like public and private API
Spree::PaymentMethod class has just two preferences:
:server: The name of your server. This defaults to
:test_mode: Sets whether the payment method can be used for test payments.
Spree::Payment objects need to be captured before they are sent to the
payment service provider for
. If the
auto_capture attribute for a payment method is set to
administrator must manually capture payments. However, you can set any payment
method to auto-capture payments.
Application-wide auto-capture default
If you have not set the
auto_capture attribute for a payment method, it
defaults to the value of your store's
Set a payment source class
Spree::PaymentMethod base class has a method called
payment_source_class. It sets the payment source that should be associated
with your payment method. When you are creating your own payment method, you
need to define a
payment_source_class (even if it is
Solidus provides payment sources such as
Spree::StoreCredit. However, payment methods included in Solidus extensions
) could use a
completely custom payment source. (For example, the
SolidusPaypalBraintree::Source as the payment source for all
Built-in payment methods
Solidus does not include working payment methods by default. However, it does offer basic payment methods you can use to help you build out your own integration with a payment service provider.
These payment methods are provided by Solidus:
Spree::PaymentMethod::Check: A class for processing payments from checks.
Spree::PaymentMethod::StoreCredit: A class for processing payments from a user's existing
Spree::PaymentMethod::CreditCard: A base class for other typical credit card-based payment methods. It uses
Spree::CreditCardas a payment source.
Solidus also provides bogus credit card payment methods for testing purposes:
You can view the source code for all of Solidus's provided payment methods in
The simple bogus credit card method does not support payment profiles.1
A payment profile is a record that pairs a specific customer with a specific credit card. Some payment gateway providers or billing systems use payment profiles while others do not. ↩
Solidus is an open source platform supported by the community. We encourage everyone using Solius to contribute back to the documentation and the code.