This is the full specification of how to integrate with Pay By Group using any of our available integration options.
If you have an online shop where you want to receive group payments, this document can guide you to setup everything you need to get started with Pay By Group.
In order to use this API you need a Pay By Group Business account and API key. To create a business account and receive an API key, visit https://www.paybygroup.com/ or contact firstname.lastname@example.org.
First, you need to choose how to receive payments from the following two options.
- Large businesses that want to ensure all their transactions are in one place and wish to maintain their current negotiated rates for credit card processing
- Any business based outside the United States
Pay By Group supports direct integration with over 80 gateways around the world and can add support for others on an as-needed basis for new clients.
- Login to your Business Portal and provide Pay By Group with credentials to run transactions on your behalf through your existing gateway.
- If you have multiple gateways, such as one per country or per currency, add every gateway through which you may want Pay By Group to run transactions
- The gateway used for a given purchase can be defined on a per-purchase basis
- Ensure the settings for each gateway you add are set to support the following credit card actions through its API:
- Authorization without requiring cvv/cvc code
- Partial capture
- Partial refund
- Pay By Group will run each individual group member’s transaction through your gateway and include optional metadata based on what your gateway supports, such as:
- User email
- Purchase ID
- Any Pay By Group fees charged to the customer over and above the amount of the purchase settle to your account, and Pay By Group bills you separately to remit those to Pay By Group on a rolling basis.
- Small and medium-sized businesses based in the United States
- Any business that prefers to receive a single deposit per completed purchase instead of the individual, constituent transactions
- Businesses that which to offer multi-currency support to their customers
- You provide Pay By Group with the details of the bank account where you wish to receive deposits.
- You will be asked to verify certain details about your business and the individual responsible for your finances in order for us to verify the account
- If you have multiple bank accounts, such as one per region or business unit, add each account to which you may want Pay By Group to send funds
- Pay By Group processes each group member’s payment on your behalf and combines them all into a single payout to your bank account when the group completes.
- The payout is triggered when a group completes, and the funds are sent as a single ACH payout per completed group. The deposits typically show in your account within 1-3 business days.