https://github.com/sucepass/pay

Payments for Ruby on Rails apps
https://github.com/sucepass/pay

Last synced: about 21 hours ago
JSON representation

Payments for Ruby on Rails apps

• Host: GitHub
• URL: https://github.com/sucepass/pay
• Owner: sucepass
• License: mit
• Created: 2024-10-09T01:59:35.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-10-09T02:06:45.000Z (about 1 month ago)
• Last Synced: 2024-10-21T06:40:19.750Z (24 days ago)
• Language: Ruby
• Homepage:
• Size: 3.83 MB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing/adding_a_payment_processor.md
  • Funding: .github/FUNDING.yml
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        


# 💳 Pay - Payments engine for Ruby on Rails

[![Build Status](https://github.com/pay-rails/pay/workflows/Tests/badge.svg)](https://github.com/pay-rails/pay/actions) [![Gem Version](https://badge.fury.io/rb/pay.svg)](https://badge.fury.io/rb/pay)



Pay is a payments engine for Ruby on Rails 6.0 and higher.

⚠️  **Upgrading?** Check the [UPGRADE](UPGRADE.md) guide for required changes and/or migration when upgrading from a previous version of Pay.

## 🧑‍💻 Tutorial

Want to see how Pay works? Check out our video getting started guide.



## 🏦 Payment Processors

Our supported payment processors are:

- Stripe ([SCA Compatible](https://stripe.com/docs/strong-customer-authentication) using API version `2022-11-15`)

- Paddle (SCA Compatible & supports PayPal)

- Braintree (supports PayPal)

- [Fake Processor](docs/fake_processor/1_overview.md) (used for generic trials without cards, free subscriptions, testing, etc)

Want to add a new payment provider? Contributions are welcome.

> We make our best attempt to standardize the different payment providers. They function differently so keep that in mind if you plan on doing more complex payments. It would be best to stick with a single payment provider in that case so you don't run into discrepancies.

## 📚 Docs

* [Installation](docs/1_installation.md)

* [Configuration](docs/2_configuration.md)

* **Usage**

  * [Customers](docs/3_customers.md)

  * [Payment Methods](docs/4_payment_methods.md)

  * [Charges](docs/5_charges.md)

  * [Subscriptions](docs/6_subscriptions.md)

  * [Routes & Webhooks](docs/7_webhooks.md)

  * [Customizing Pay Models](docs/8_customizing_models.md)

* **Payment Processors**

  * [Stripe](docs/stripe/1_overview.md)

  * [Braintree](docs/braintree/1_overview.md)

  * [Paddle](docs/paddle/1_overview.md)

  * [Fake Processor](docs/fake_processor/1_overview.md)

* **Marketplaces**

  * [Stripe Connect](docs/marketplaces/stripe_connect.md)

* **Contributing**

  * [Adding A Payment Processor](docs/contributing/adding_a_payment_processor.md)

## 🙏 Contributing

If you have an issue you'd like to submit, please do so using the issue tracker in GitHub. In order for us to help you in the best way possible, please be as detailed as you can.

If you'd like to open a PR please make sure the following things pass:

```ruby

bin/rails db:test:prepare

bin/rails test

bundle exec standardrb

```

## 📝 License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).