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    

2. Merchant's cart API


Requires configuration for your account by Pay By Group

For this option to work, you must discuss it with your Pay By Group account manager to have Pay By Group configure the adapter(s) that will make call(s) to your API.

If you have an API that Pay By Group can use to retrieve details of a customer’s cart or of the inventory they want to split, then you can pass a cart ID, inventory ID, or similar identifier to Pay By Group instead of individually passing all the parameters described in the createPurchase method. Pay By Group will build an adapter that uses that ID to make a request to your system for the purchase information and map the data that is returned to Pay By Group’s purchase parameters. This is the best way to minimize your work to add the Pay By Group option, assuming you have an API Pay By Group may use to retrieve the needed information.

You may pass the cart/inventory ID using the JS SDK or API option. If you want to pass information that is not available for Pay By Group to retrieve from your API in addition to the cart/inventory ID, include the other information as additional attributes when calling the createPurchase method.

Examples of additional parameters not available from the merchant’s API include those that are recommended for creating a purchase and those needed to ultimately create the desired order in your system (e.g. coupon code the user entered).

Updated 3 years ago

2. Merchant's cart API

Suggested Edits are limited on API Reference Pages

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