API Reference

API Reference

Complete method reference for all PushPay Ruby gem classes.

PushPay (Module)

Method	Description
PushPay.configure { |c| ... }	Configure the gem
PushPay.client	Get the singleton client instance
PushPay.configuration	Access current configuration
PushPay.reset!	Reset client and configuration

PushPay::Payment

Method	Description
find(payment_token, merchant_key: nil)	Get a payment by token
list(merchant_key: nil, **params)	List merchant payments
list_for_organization(organization_key: nil, **params)	List org payments

PushPay::RecurringPayment

Method	Description
find(payment_token, merchant_key: nil)	Get a recurring payment
list(merchant_key: nil, **params)	List merchant recurring payments
list_for_organization(organization_key: nil, **params)	List org recurring payments
payments(payment_token, merchant_key: nil, **params)	List linked payments

PushPay::AnticipatedPayment

Method	Description
create(params, merchant_key: nil)	Create an anticipated payment
list(merchant_key: nil, **params)	List anticipated payments

PushPay::Merchant

Method	Description
find(merchant_key)	Get a merchant by key
search(**params)	Search merchants
in_scope(**params)	List accessible merchants
near(latitude:, longitude:, country: nil, **params)	Search nearby merchants

PushPay::Organization

Method	Description
find(organization_key)	Get an organization
search(**params)	Search organizations
in_scope(**params)	List accessible organizations
campuses(organization_key: nil, **params)	List campuses
merchant_listings(organization_key: nil, **params)	List merchant listings

PushPay::Fund

Method	Description
find(fund_key, organization_key: nil)	Get a fund
list(merchant_key: nil, **params)	List merchant funds
list_for_organization(organization_key: nil, **params)	List org funds
create(params, organization_key: nil)	Create a fund
update(fund_key, params, organization_key: nil)	Update a fund
update_status(fund_key, params, organization_key: nil)	Change fund status
delete(fund_key, organization_key: nil)	Delete a fund

PushPay::Settlement

Method	Description
find(settlement_key)	Get a settlement
list(merchant_key: nil, **params)	List merchant settlements
list_for_organization(organization_key: nil, **params)	List org settlements
payments(settlement_key, **params)	List settlement payments

PushPay::Batch

Method	Description
find(batch_key, merchant_key: nil)	Get a batch
list(merchant_key: nil, **params)	List merchant batches
list_for_organization(organization_key: nil, **params)	List org batches
payments(batch_key, merchant_key: nil, **params)	List batch payments

PushPay::Webhook

Method	Description
find(webhook_token, merchant_key: nil)	Get a webhook
list(merchant_key: nil, **params)	List merchant webhooks
create(params, merchant_key: nil)	Create a webhook
update(webhook_token, params, merchant_key: nil)	Update a webhook
delete(webhook_token, merchant_key: nil)	Delete a webhook

PushPay::Client

Method	Description
authenticate!	Manually trigger OAuth authentication
get(path, params = {})	HTTP GET
post(path, data = {})	HTTP POST
put(path, data = {})	HTTP PUT
patch(path, data = {})	HTTP PATCH
delete(path)	HTTP DELETE
access_token	Current access token
token_expires_at	Token expiration time

Error Classes

Class	HTTP Code	Key Attributes
PushPay::Error	—	Base error
PushPay::ConfigurationError	—	message
PushPay::AuthenticationError	401	message
PushPay::APIError	Various	status_code, response_body
PushPay::ValidationError	400, 422	errors (hash)
PushPay::NotFoundError	404	status_code
PushPay::RateLimitError	429	retry_after