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
purchasemade through Pay By Group must occur under a
- Purchase: a
purchaseis 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
productis a nested object inside the
purchasethat defines all the details of what is being bought.
- ProductCost: the
product_costis a nested object inside the
productthat allows you to vary the price of the
purchasebased on the size of the group making the purchase.
- Payment: a
paymentis a nested object (or array of objects) inside a purchase describing the amount(s) a merchant expects to receive for a given
purchaseover time as a % of the
product_cost(s). A single
purchasemay 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
- Membership: the
membershipdefines the relationship between a single end-user and the
contribution(s)are nested inside the
membershipand describe the relationship between each member and each
payment, so a
membershipcan have multiple contributions, 1 for each
- Transaction: a
transactionis 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
useris a single end-user who can have multiple