When you register for your Spreedly Organization, you will receive an organization key. These credentials do not enable you to transact on the API, but will allow you to create the Spreedly environments that you will transact in.
Now that you have a Spreedly Organization, you will want to create your API credentials. At Spreedly, these credentials are the environment key and single-environment access secret.
Your payment data at Spreedly is organized in environments. When you create an environment in your Organization, you will receive an environment key to represent that environment. You can also provide a name for that environment (e.g. “Testing” or “Production”).
Your environments are not restricted to only one choice of test traffic or production traffic, but we recommend that you create at least two environments separately for these purposes. (You may even simply call these “Testing” and “Production”.) This way, you can separate your test data from your production data more easily for reporting purposes.
You can create additional environments directly from your dashboard in app.spreedly.com. After logging in, click on the Environment tab at the top of the side menu bar, and select “Create new environment”. From here, simply enter a name for your environment, select a “Payment method submission” option, and select “Save changes” to create the environment.
Now that you’ve created an environment, you’ll need to create an access secret.
There are two kinds of access secrets: an “organization” and a “single-environment” access secret. An “organization” access secret, like the one you created when you registered for your Spreedly account, can be used to authenticate any API call in your Organization. While this has its uses, we strongly recommend creating a “single-environment” access secret for each of the environments that you create at Spreedly; this enhances security and ensures that you are only authenticating API calls to the intended environment.
To create a single-environment access secret in app.spreedly.com, use the Environment tab at the top of the sidebar menu, navigate to “Access secrets”, and then select the “Add access secret” button. Please note that you will need to copy this access secret to store in a secure manner, as it will no longer be viewable after you navigate away from the page.
Now that you have an environment key and an access secret, you can begin authenticating API requests. Spreedly uses HTTP Basic Authorization for API requests.
While you now have the credentials you’ll need to access Spreedly, you may also need credentials to send payment data to another party, like a gateway processor, through Spreedly. If you do not already have your sandbox and production credentials at your connections, we encourage you to obtain those as soon as you can. You’ll need those credentials to interact with those endpoints. Please reach out to those parties directly to acquire your credentials.
Merchant Aggregators vs Merchants of Record
What type of customer am I?
Spreedly generally has two types of customers: merchant aggregators and merchants of record.
As a merchant of record, your business will own the relationship with your acquirer and processors.
As a merchant aggregator, your business will facilitate the ability for other businesses to transact on your platform, though you likely don’t manage the relationship with your clientele’s acquirers and processors.
Your use case may even be a combination of these models, both managing your own transactions and facilitating the transactions of other businesses. In this case, we recommend you review our documentation on these use cases and read on in this guide.
Using Spreedly as a Merchant Aggregator
If your business matches Spreedly’s merchant aggregator model, please visit our guide on Merchant Aggregator Services. There are some extra considerations that you will want to understand configuring this customer model.
For example, will your clientele need to share a single production environment? Will you want to segment your clientele into individual production environments?
As a merchant aggregator, you may want to create environments and environment access secrets using the API, especially if you want to automate parts of your merchant onboarding process. There are sections for these requests in our API reference.
In Spreedly terminology, you may see the term “sub-merchant”. We refer to your clientele as sub-merchants of you, the merchant aggregator. But there is also a sub-merchant object that you can create via the API to assist in reporting purposes. We recommend creating a sub-merchant object for each of your clients in the environment(s) in which they transact.
You have completed Module 1 if you:
have an environment key
have an access secret
know if you're a Merchant Aggregator or a Merchant of Record