spree-payments

Manage payment methods, gateways, sessions, and refunds in Spree Commerce.

4|Updated Jun 9, 2026
One-click install
npx skills add https://github.com/spree/agent-skills --skill spree-payments
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spree-payments
Source: https://github.com/spree/agent-skills/tree/main/skills/spree-payments
Command: npx skills add https://github.com/spree/agent-skills --skill spree-payments

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill simplifies working with Spree's payment system, including payment methods, gateways, payment sessions, and the payment state machine.

Core Features & Use Cases

  • Payment Method Configuration: Manage and configure payment methods like Stripe, Adyen, PayPal, and more.
  • Payment Session Management: Handle payment sessions for hosted forms and drop-in widgets.
  • Payment State Machine: Understand and manage the various states of a payment, including checkout, processing, pending, completed, failed, void, and invalid.
  • Refunds and Store Credits: Process refunds and issue store credits.
  • Gift Cards: Manage gift cards and their balances.
  • Use Case: If you're running an e-commerce store on Spree Commerce and need to integrate and manage various payment gateways, this Skill provides the necessary tools and information.

Quick Start

Use the spree-payments skill to configure a new payment gateway for Stripe.

Frequently Asked Questions about spree-payments

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure a payment gateway in Spree Commerce?

You can configure payment gateways like Stripe, Adyen, or PayPal in Spree Commerce by managing payment methods and integrating the corresponding gateway extensions into your store's payment system.

What states are included in the Spree Commerce payment state machine?

The Spree Commerce payment state machine includes checkout, processing, pending, completed, failed, void, and invalid states. Managing these state transitions ensures accurate tracking of each payment's lifecycle.

How do I process refunds and issue store credits in Spree?

To process refunds and issue store credits in Spree, you use the payment management tools to handle return transactions. This functionality allows you to return funds to customers directly or via store credit balances.

Can I handle payment sessions for hosted forms in Spree Commerce?

Yes, you can handle payment sessions for hosted forms and drop-in widgets in Spree Commerce. This involves managing the session data required by external payment gateways to securely process checkout transactions.

Does Spree Commerce support managing gift card balances?

Yes, Spree Commerce supports managing gift cards and their balances. You can use the payment system tools to issue, track, and redeem gift cards alongside standard payment methods and store credits.

What is the best way to manage multiple payment methods in Spree?

The best way to manage multiple payment methods in Spree is by using the integrated payment system to configure various gateways. This allows you to simultaneously support Stripe, PayPal, and other methods while handling their specific state transitions.