Building blocks for group payments

Pay By Group makes it easy to accept payment from a group of customers online - in your app or on your site. Get integrated quickly by reviewing the Sample Scenarios, and select from our range of API (back-end) and JavasScript Library (front-end) integration tools.

Get Started    

Objects & Relationships

This is a high-level view of the relationship between different objects in the Pay By Group ecosystem. Once you know how different objects relate to each other, it is easier to know which object to use for various use cases. Each one is linked to its definition in our API Reference, which includes a list of all its attributes.

  • Merchant: when a new business signs up with Pay By Group, they become a merchant. A business can have multiple merchants, and every purchase made through Pay By Group must occur under a merchant.
  • Purchase: a purchase is equivalent to an "order" or "booking" in a merchant's traditional workflow and is the unifying object that connects multiple buyers to a single order.
  • Product: the product is a nested object inside the purchase that defines all the details of what is being bought.
  • ProductCost: the product_cost is a nested object inside the product that allows you to vary the price of the purchase based on the size of the group making the purchase.
  • Payment: a payment is a nested object (or array of objects) inside a purchase describing the amount(s) a merchant expects to receive for a given purchase over time as a % of the product_cost(s). A single purchase may have multiple payments over time, which may be a deposit + balance payment or a series of installments. Most purchases have a single payment for 100% of the purchase value.
  • Membership: the membership defines the relationship between a single end-user and the purchase.
  • Contribution: contribution(s) are nested inside the membership and describe the relationship between each member and each payment, so a membership can have multiple contributions, 1 for each payment.
  • Transaction: a transaction is the most granular object that exists in the Pay By Group system from a financial tracking standpoint and represents every charge or refund to a Payment Source and every credit or debit with a Payment Destination.
  • User: each user is a single end-user who can have multiple memberships across different purchases.

Updated about a year ago

Objects & Relationships

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.