Before starting Module 1, work out which type of Spreedly customer you are. Your answer affects how you set up environments, gateways, and reporting in every module that follows, and it’s much easier to get right now than to change later.
By the end of this section, you will be able to:
- Identify whether you’re a merchant of record, a merchant aggregator, or both
- Know which guides to follow alongside the onboarding modules
- Understand the key setup decision aggregators need to make before Module 1
________________________________________________________________________
What Type of Customer Am I?
Spreedly has two main types of customers:
| Merchant of record | Merchant aggregator (or “platform”) | |
|---|---|---|
| Who you process payments for | Your own business | Other businesses that transact through your platform |
| Who owns the gateway and acquirer relationships | You do | Usually your clients do |
| Whose gateway credentials you use | Your own | Each client’s |
| Your path through onboarding | The onboarding modules as written | The onboarding modules plus the Merchant Aggregator guide |
Some ask yourself:
- Are the payments for my own sales? If yes, you’re a merchant of record.
- Do other businesses use my software to take payments, with their own gateway accounts? If yes, you’re a merchant aggregator.
- Both? For example, you sell your own subscriptions and also process payments for clients. Then you’re a combination. Follow both paths, and see Merchant onboarding for how to set up each model.
_____________________________________________________________________
If You’re a Merchant of Record
You’re ready to start. Continue to Module 1: Setting Up Your Spreedly Organization.
______________________________________________________________________
If You’re a Merchant Aggregator
Follow the onboarding modules as usual, and read Using Spreedly as a Merchant Aggregator alongside them. It’s organized to match each module, with the extra steps that apply to you.
Before Module 1, think about these three things:
1. One environment per client, or one shared environment?
Cards and gateways stored in Spreedly only work in the environment where they were created. So decide early:
- One environment per client (recommended): keeps each client’s cards, transactions, and reports separate. It’s also required to offer every Advanced Vault feature to clients individually.
- One shared environment: needed only if your clients must charge the same stored cards.
The Merchant Aggregator guide compares both options in detail.
2. Automating client onboarding
If you’ll onboard clients regularly, plan to create environments and access secrets through the API instead of the Spreedly App:
- Create an environment:
POST /v1/environments - Create an access secret:
POST /v1/environments/{environment_key}/access_secrets
See the API reference for details.
3. Sub-merchants
Spreedly calls your clients sub-merchants. Separately, there’s a sub-merchant object you create through the API (POST /v1/sub_merchants) to tag gateways and transactions for reporting. Create one for each client in the environment(s) where they transact.
Using Composer? See Composer for platforms and merchant aggregators.
______________________________________________________________________
Getting Help
If you’re not sure which model fits your business, contact your Account Manager or Customer Support before starting Module 1.
______________________________________________________________________
Checklist
You’re ready for Module 1 when you have:
- Identified whether you’re a merchant of record, a merchant aggregator, or both
- If you’re an aggregator: read the Merchant Aggregator guide
- If you’re an aggregator: decided between one environment per client and a shared environment
- If you’re an aggregator: planned whether to automate environment and sub-merchant setup through the API