Home

PushPay Ruby Gem

A Ruby gem for integrating with the PushPay payment processing API.

Overview

This gem provides a clean, idiomatic Ruby interface to the PushPay REST API. It handles OAuth 2.0 authentication, token management, and provides resource classes for all major API endpoints.

Supported Resources

Resource	Class	Description
Payments	PushPay::Payment	View payment transactions
Recurring Payments	PushPay::RecurringPayment	View recurring payment schedules
Anticipated Payments	PushPay::AnticipatedPayment	Create and list payment links
Merchants	PushPay::Merchant	Search and view merchant details
Organizations	PushPay::Organization	View organizations and campuses
Funds	PushPay::Fund	Manage funds (CRUD)
Settlements	PushPay::Settlement	View settlement batches
Batches	PushPay::Batch	View check deposit and batch entry batches
Webhooks	PushPay::Webhook	Manage webhook subscriptions

Quick Links

• Getting Started - Installation and first API call
• Configuration - Setting up credentials and options
• Authentication - How OAuth 2.0 works with this gem
• Error Handling - Handling API errors gracefully
• API Reference - Complete method reference

Requirements

• Ruby >= 2.7.0
• A PushPay developer account with API credentials

Links

• PushPay API Documentation
• PushPay API Swagger
• GitHub Repository