Spreedly FAQs

Spreedlys pricing is based on API usage and the number of endpoints. We created this guide to provide some tips on how to get the most out of your pricing plan and streamline your transaction flow. The first pro tip, as a general rule of thumb it is between 1 to 3 API calls to successfully process a credit card transaction. This will depend on whether the card is being added for the first time or is already stored, whether youre doing an authorization too, or simply a purchase.

For example, a 3 call transaction might look like:

Add a card

Run an authorization retaining on success

Run a capture

If this is a repeat/recurring transaction, it could be as simple as running a purchase, and thus be only one API call.

As always, if you have any questions about our pricing or would like to speak with someone about the best practices for optimizing your technical flow, write to us at [email protected], and well be happy to help!

Are test transactions free?

Under API pricing, paid Spreedly subscribers will pay for all API calls used for test transactions as well as production transactions. For load testing, we recommend simulating the load rather than using the Spreedly test gateway for load testing. Or maintaining a separate trial account post-subscription. For more information, you can visit our documentation on testing.

How can I make my API calls more efficiently?

Each API request can take 100-400 milliseconds - thats without considering gateway latency, which can be as high as 60 seconds. Reducing the number of API calls made in the transaction process could shave seconds or even minutes off of your customers checkout experience, creating a more efficient (and cost-effective) workflow.

Over the last year, we looked at the most common ways users interact with our API, and compiled some tips to help reduce the number of API calls made to Spreedly and streamline your workflow:

Log important metadata details server-side in case you need to access them later. Repeatedly calling the list and show API calls for reconciliation can be avoided by systematically logging transaction responses when they are first performed. When you create a payment method or perform a transaction, Spreedly returns information in the response body that includes data like the card brand, first six and last four digits of the card, customer name, address and more. If you need that data, it is more effective to log it at the time of the corresponding transaction response than to make separate API calls every time it is needed.

Use the retain_on_success flag to store payment methods. Performing an authorize, capture, verify, or another transaction call with this flag turned on will store the card in one API call, whereas making a separate call just to retain a card will be counted as an additional API call. This also bypasses the need to use the `add payment method` call.

If your flow uses Authorize + Capture, consider trying a single-transaction flow like a Purchase call. Businesses that ship physical goods may want a confirmed successful authorize to ship a product. However, other users may benefit from trimming down the transaction process and reducing the number of API calls made.

Make sure youaren'tcreating a new gateway before every transaction. Gateways only need to be created once, and you can reference the already-created gateway token in the future to make a purchase.

Turn off AVS requirements at your gateway, if applicable. Youll eliminate the need to update a users entire payment method record in order to make successful transactions, just because their address associated with the card changes. You may want to discuss this approach with your gateway first, as passing an incorrect address could affect your transaction success rate.

Send API calls to Spreedly in proper JSON/XML formatting. Every day, we see thousands of authenticated API calls passing through Spreedly thataren'tformatted with JSON or XML. Be sure that youre adhering to conventions when youre interacting with the API.

Increase your pagination limit when using the List call. When you use the list call, the default number of records displayed is 20. If youre planning to paginate through many results, set the number of records returned to the maximum (100) as each pagination call will count as a billable API call.

Use Spreedlys debugging UI in your Dashboard to pull transaction transcripts and response bodies for troubleshooting. Your Dashboard provides the resources you need to debug your transaction and reach out to your gateway/Spreedly to address any problems.

Keep track of automated testing scripts running in the background. Test transactions on paid Spreedly accounts will count as a billable API call, so take inventory of any testing youre currently performing in order to reduce the number of test transactions counting towards your monthly bill. Check out our documentation for testing for more advice.

Enable number formatting on iFrame or Express. Number formatting prevents your users from entering numbers that have more/fewer digits than expected for their card type. It can be helpful in ensuring that youre only storing or attempting transactions with valid card data.

Secure your access secrets by never sharing them through unsecured channels like unencrypted e-mails or chats. By protecting the security of your Spreedly account, you can take control over how many API calls are being made through your organization.

Stay informed on Spreedly uptime by subscribing to updates on our StatusPage or ping core.spreedly.com with an unauthenticated request. With status.spreedly.com, you can receive e-mail, text, Twitter, and Atom/RSS notifications if there is an incident with Spreedly. Our StatusPage updates also populate to our Support Twitter, and you can turn on notifications to be alerted of any activity from us there. You can also ping our core API at core.spreedly.com with an unauthenticated call such as the list supported gateways call and track whether or not Spreedly provides a response.

NOTE: If you are an existing customer not on API-based pricing reach out to your Customer Success Manager or reach out to [email protected].

Platform Fee

Endpoints

API Calls

Legacy Pricing

Subscribe to Spreedly

Your monthly bill will be calculated as an accumulation of the following factors across all the environments in your organization:

the platform fee you select on the pricing page

the number of distinct endpoints - payment gateways and receivers

the number of API calls executed during the billing period

You can view your organization's accrued fees in the Spreedly Dashboard.

Platform Fee

All Spreedly plans include access to our custom tools, unlimited secure card storage, access to hundreds of supported gateways, and the ability to add a qualified Flex end point.

Spreedly has several pricing tiers to choose from based on your company's needs. Companies with one or two gateways might opt for the Starting plan, while companies who want to add and use myriad gateways will want to choose one of the higher plan levels. An added benefit of the plans with a higher monthly platform fee would be a lower per API call price.

Activate your Spreedly account

Endpoints

An endpoint is a gateway (Stripe, Authorize.Net, WorldPay) or a Receiver (Clover, Mastercard, Shopify). In our most basic plan, you are allowed two endpoints, e.g. Stripe and Cybersource. Note: there are no limits on the number of merchant accounts you can have.

It is important to note that a gateway or receiver, in terms of billing, means the number of distinct types of gateways and receivers thatyou'veprovisioned. For instance, if you have five Authorize.net gateways retained across your organizations environments your gateway count is one (not five).

Only retained, non-test, gateways and receivers count towards your plans storage limit. Gateways and receivers that are redacted cannot be used to conduct transactions and, thus, are not counted towards your plans limit.

To find out whichgateways and receivers you have retained, you can use the Dashboard or the API. If you exceed your plans limit you will automatically be bumped to the next plan.

We will only automatically upgrade your plan if your endpoint usage exceeds your plans capacity. All other upgrades and downgrade activity is done by you, manually.

API Calls

Spreedly only charges you for the API calls you make. Your choice of pricing plan will directly influence what your per-API-call fee will be. If you are a higher volume customer, it may make sense for you to pay a larger monthly platform fee to take advantage of the drastically lower per-API-call fee.

A general rule of thumb is between 1 to 3 API calls to successfully process a credit card transaction. This will depend on whether the card is being added for the first time or is already stored, whether youre doing an authorization too, or simply a purchase.

For example, a 3 call transaction might look like:

Add a card

Run an authorization retaining on success

Run a capture

If this is a repeat/recurring transaction, it could be as simple as running a purchase, and thus be only one API call.

It's important to note that test API calls in trial accounts are free. Test API calls in production accounts, however, are metered and billed. Any threshold management or alerting must be handled programmatically by the customer.

Legacy Pricing

Spreedly has several legacy pricing plans still in production with customers. If you are a current customer and do not see your pricing plan listed above, please contact Customer Success with any questions. Invoices will be sent to the email address on file.

For those legacy customers whose plans included a subsidized per transaction rate, the following is a list of our partner gateways:

Authorize.net

BlueSnap

CardConnect*

Credorax

DLocal

Kushki

MercadoPago

PayPal

PayU Latam

Paymentez

Pin Payments

ProPay

SafeCharge

SagePay

Stripe

VR Payment

Worldpay

*Note: CardConnect gateway has a different partnership agreement with Spreedly than the other gateways on this list. As such, they do not include a subsidized per transaction rate.

Subscribe to Spreedly

Ready to subscribe? now.

In todays blog post we will be looking at how Pinfire Labs utilizes our Flex functionality to be able to offer PCI-compliant card-not-present online sales as part of their RecHub product, which helps outdoor recreation organizations such as sailing clubs be able to offer online class signups, recurring invoicing and online reservations. This post is guest authored by Justin Cherniak, founder and CEO of Pinfire Labs.

View the full case study on the Spreedly blog.

Request a new gateway integration

Request 3DS on an existing gateway integration

Request a gateway-specific field

Request a new Flex receiver endpoint

Request a new gateway integration

While we are always open to adding support for new gateways on Spreedly, we are currently integrated to 100+ gateways that span the globe and offer a variety of existing options for customers to choose from.

For Spreedly to consider new gateway additions, the existing customer would need to contact our Customer Success team to provide the following:

What are your blockers to using existing Spreedly gateways?

Is the gateway a requirement of your transaction flow or a preference?

Do you agree to pay the one-time up front cost of a new gateway implementation?

What is the requested timeline for the gateway? Please note: the timeline for implementation can vary greatly depending on the responsiveness of the gateway's technical team, the current size of our development queue, and the complexity of the integration.

A contact name and email address at the gateway.

Any API/technical documentation for for the gateway.

It's important to note that, if Spreedly decides to add your requested gateway, an integration can several months and this integration period should be accounted for in any go-live plans you may have.

Request 3DS on an existing gateway integration

While we are happy to consider adding a new 3DS integration for you, there are costs and considerations before moving forward. New integration requests are reviewed on a case by case basis for technical compatibility and business fit, and the integration fee (explained below) must be collected in full if the integration is approved.

1. If you have a relationship with a 3rd party 3DS provider (like Cardinal Commerce), we can add them via Flex. With this method, you can start transacting much quicker than adding a new Spreedly integration from scratch.

2. The one-time cost of a new 3DS implementation to be paid up front by you, the customer.

3. The timeline for implementation can vary greatly depending on the responsiveness of the gateway's technical team, the current size of our development queue and complexity of the integration.

If you have fully considered the above and wish to move forward, please reach out to us with the following information:

Is 3DS a requirement of your gateway/transaction flow or is it a preference?

What are your blockers to using existing Spreedly 3DS integrations?

Please provide us with an e-mail address for your contact at the gateway as well as their 3DS technical documentation.

Request a gateway-specific field

Spreedly is happy to consider the addition of gateway-specific-fields for current Spreedly customers.

We require the following for all requests:

The gateway name

The use case for adding the new field

The gateway documentation for integrating the field(s) of interest

To submit your request, please contact the Support team via email.

Request a new Flex receiver endpoint

You can check out our current provisioned receivers here.

If youd like to work with a non-gateway endpoint that wedon'tcurrently support, we will need some information about your receiver:

A signed and current attestation of PCI compliance (AOC)

A current ASV Scan Report Attestation of Scan Compliance from a licensed vendor

After receiving this information, it usually only takes a week or two to begin transacting against your receivers API with real cardholder data.

Contact Support to make a request.

https://id.spreedly.com

Spreedlys Account Updater allows you to always keep your customers card details up-to-date. When your customers credit card numbers expire or are updated,Account Updater protects you from the lost revenue, involuntary churn and decreased customer satisfaction associated with outdated payment information.

Jump to:

Who is eligible for Account Updater?

Which cards are eligible for Account Updater?

What are the costs?

How do I enable this feature?

Which of my cards will be updated?

What do I need to do once I turn Account Updater on?

How do I know when my cards are updated?

Do I receive a callback when a card is updated?

Can I leave the Account Updater program?

Who is eligible for Account Updater?

All customers are eligibleto opt into the Account Updater feature.

Which cards are eligible for Account Updater?

What are the costs?

There is noup-frontcost to turn on the Account Updater feature. Once you opt-in, Spreedly will submit all of the cards in your Spreedly vault for updating twice monthly, on the 1st and 15th of every month. You can also opt in on a card level.

The cost of Account Updater can be seen on the pricing page in the Add-on section. Account Updater costs will be added to your monthly subscription renewal charge. If you exceed your plan usage levels before your renewal date, any pending Account Updater fees will be added to the total cost of your upgrade.

For more information, please view the Account Updater section in our Terms of Service.

How do I enable this feature?

You have the option to add Account Updater to your plan when logged in to https://id.spreedly.com. To opt in, click the "Edit Settings" button on the Organization tab:

Click the toggle to opt in (it will move from gray to blue) and click "Save".

Afteryou've made the update, Account Updaterwillappear on your invoice as a line item for $0.00:

Spreedly only charges per card updated or flagged as a result of the Account Updater service.Anycharges for Account Updater will appear on your next plan renewal or subscription upgrade, whichever comes first:

Which of my cards will be updated?

Once you opt into Account Updater, you can select which of your cards will be sent to the card networks for updating.

By default, all payment methods are going to be included in Account Updater. In order to exclude payment methods from being sent to Account Updater, you will need to set the value `eligible_for_card_updater` to `false`. This value can be set when creating a payment method or by using the ` update ` API call.

Opting-in to Account Updater happens at the organization level - all environments will be affected. By turning on the Account Updater feature, you confirm that all eligible cards will be sent to the card brands for updates twice monthly, but you will only be charged for those cards that are actually updated or flagged.

Merchants should only submit cards that they are willing to update. Cards that were marked "Card bank not in program" in prior runs might be updated on future runs based on program expansion and issuer participation.

What do I need to do once I turn Account Updater on?

Cards are automatically updated by Spreedly in the background and your customers can continue using your service without interruption.

How do I know when my cards are updated?

We will send you an e-mail notification when your cards are sent for updating:

and we will send another e-mail once they have been updated:

Each e-mail will notify you of how many cards were submitted for updating, and, if applicable, how many were updated.

Notifications will be sent to all members of your organization on Spreedly. Please keep your billing e-mail up-to-date as well as the e-mails of any of your Spreedly account holders to ensure your team isreceiving notifications for the Account Updater service.

Results of Account Updater submissions can be tracked in your Spreedly dashboard.

You can view summary statistics for each twice-monthly submission (or batch). You can also drill into detailed per-card results and download a CSV report for any given batch right from the dashboard.

The status for each card is shown:

ReplacePaymentMethod - The number and/or expiration date has been updated.

InvalidReplacePaymentMethod - We received either a new card number or expiration date that was invalid. The payment method was not updated, but a fee is still created since our service provider still charges us in this scenario. No changes are made to the payment method.

ContactCardHolder - Contact the cardholder for a new number and/or expiration date. This status is a flag, so no changes are made to the payment method.

ClosePaymentMethod - The account is no longer open and should no longer be used. The payment method will remain available, but Spreedlys Account Updater will no longer attempt to update it.

While not preferred, you can also track which payment methods were affected by Account Updater, using the list transactions API for the above transaction types. We recommend using the dashboard method above as using the list API will result in additional fees on API pricing plans.

Do I receive a callback when a card is updated?

Callbacks are available for pre-paid Account Updater accounts only. Please contact [email protected] for more information.

For technical details on callbacks, visit our Account Updater technical guide.

Can I leave the Account Updater program?

You may opt-out of the Account Updater program at any time. To do so, log into, go into your Organization Settings, click "Edit Settings", turn the toggle off, and click "Save". This will remove you from the Account Updater program.

Note that all changes to your Account Updater enrollment status must be made before 12PM EST the day before cards are updated by Spreedly.If you opt-out of Account Updater after this time, your cards will still be updated in the next round of processing, and you will still be charged for each updated card.

Jump to:

Everything at a glance

Navigate between multiple organizations

Get to anywhere from the sidebar

View your Insights

Drill down on your recent transaction history

View details about your Spreedly gateways

Everything at a glance

When you first log into Dashboard, you'll get an overview of your account. This include the number of gateway types currently retained and information related to your current plan. You'll also see a quick snapshot of transaction performance for all your environments in an Insights graph. Just like Insights, you can click and drag on the graph to drill down on a particular period of time.

Contact Customer Success

Not seeing any graphs?Users that only have test transactions will not see graphs or transaction information here, as Insights is only pulling from your production history.

Navigate between multiple organizations

If you're a developer with access to more than one Spreedly organization, you can quickly switch between organizations from the Dashboard.

In the upper right-hand corner, click on your username (the e-mail you signed up with), and a drop-down menu with all your associated organizations will appear. Click on the one you'd like to view, and your Dashboard will automatically change to the organization you selected:

Get to anywhere from the sidebar

In Dashboard, our sidebar helps you navigate to key points in the Spreedly ecosystem. You can access Insights, check out recent transactions, view gateways, manage your account, view billing details, get in touch with support, and see our developer docs:

Some of our sidebar links will take you outside of Dashboard - these are noted with theicon.

Within the Dashboard, there are two sections to help you understand your Spreedly account: Transactions and Insights.

View your Insights

Spreedly Insights has moved to the dashboard.Insights in Dashboard is the same feature that you know and love from our previous releases - now it's just easier to find.

For more information on using Insights, check out our blog release here.

Not seeing any graphs?Users that only have test transactions will not see graphs or transaction information here, as Insights is only pulling from your production history.

Drill down on your recent transaction history

Need to know why a transaction failed? Debugging transactions from your browser has never been easier. Navigate to the Transactions tab in your Dashboard to access a list of your most recent transactions.

By default, you will view all transactions across your environments. To drill down to one specific environment, select it from the drop-down menu to filter:

Clicking on any transaction will pull up information relevant for debugging - e.g. whether or not the transaction was successful, and what error/success message is associated with it.

You can also look up any transaction token you have on hand through the "Look Up" feature at the top of the screen:

When viewing a specific transaction, at the bottom of the screen, you can tab between the transcript (communication between Spreedly and a payment gateway - not available for Spreedly-only transactions such as adding/redacting payment methods) and the JSON response body (Spreedly's response back to you after a transaction is completed).

Note:You can lookup test transactions in this section, but they will not appear in Insights or under Gateways.

If you find `gateway_processing_failed` or `gateway_processing_results_unknown`, your best bet is to copy the transcript and share that with the gateway so they can elaborate on why you're seeing that particular failure from them.

Check out our guide on troubleshooting for more helpful information on examining your transactions. Or contact Customer Support if you need technical support.

View details about your Spreedly gateways

Spreedly has added the ability to review information about retained gateways in the Dashboard. In this section you can see the total number of tokens stored by gateway type, properties and transaction details associated with each gateway token, and specific details on each gateway such as supported payment methods, operations and countries.

By default, you will view all all gateways across your environments. To drill down to one specific environment, select it from the drop-down menu.

Note: Spreedly Test Gateways won't display on the dashboard

To view details on a gateway type, select the Gateways tab on the navigation bar then select the gateway you want to view. From this page you can view information on supported payment methods, operations, and countries. You can also review recent transactions and drill down to the specific transaction details.

If you have the gateway token and you want to navigate directly to the token details page, there is a lookup function located on the main Gateway page. Enter the gateway token into search bar and hit Enter or click the Look Up button to navigate directly to the token details.

One of the most powerful pieces of feedback we receive is from customers who have the entirety of their business running through Spreedly. This Dashboard makes Spreedly a really powerful data analytics tool for your payments, but only if you have consolidated your payments processing through Spreedly. Otherwise, your data is fragmented, acting on trends may take too long and come too late, and reconciliations are much harder than they have to be.

Do you have other payments processing outside of Spreedly? We'd love to know more about why that is and how we can help unify your data. to discuss your payments strategy and growth plans.

To follow along with this guide, please log into your account at https://id.spreedly.com.

Jump to:

Adding Users

Controlling invitations

Removing users

Find yourOrganization ID

Adding users

Only add trusted users to your organization. All Spreedly users in your organization have administrator privileges - they can manage and access your list of API access secrets, remove users, cancel your organizations Spreedly subscription, and take other actions.

To add a Spreedly user to your organization, head to theOrganizationtab when logged into your account and view the Administrators list (located below your Access Secrets):

https://id.spreedly.com

Controlling invitations

If you need to revoke an outstanding invitation or grab the direct sign-up link for the invited user, you can do so from the Organizations tab when logged into your account.

Invited users who have not accepted their invitation yet will be listed at the bottom of your Administrators list:

If the user is already a member of another Spreedly organization, they will need to click on "Already have a user account?" to log in. They should not create a new login.

Removing Users

If you need to remove a user from your account for any reason, please contact us with your organization ID and the e-mail of the user youd like to remove. Here's a template you can use to make your request:

Hi Spreedly,

I'm writing from SureFire Labs (ID: abc123def456). We would like to remove [email protected] from our Spreedly account as they no longer need administrator privileges.

Find your organization ID

Your organization ID is visible in your URL when you are logged inat:

You may add users to your Spreedly account so they can manage and view your access secrets and account settings for testing.

Only add trusted users to your organization. All Spreedly users in your organization have unlimited access to youraccount - they can add and delete users, revoke API access secrets, and change your subscription plan.

To add a Spreedly user to your organization, head to the Organization tab when logged into your account. Below your list of Access Secrets, you will see a list of administrators. At the bottom, there is an option to add a new user:

guide on managing users

The user you invite will receive an e-mail at the address you specify. The e-mail includes instructions on how to set up a username and password that will connect them to your Spreedly account.

If the user is already a member of another Spreedly organization, they will need to click on "Already have a user account?" to log in. They should not create a new login.

Need to remove an administrator? Check out our .

We are happy to migrate your data into Spreedly if you are coming to us from a PCI compliant storage service. Importing your card data is free for every unique gateway or vaulting service you're moving away from.

There are two options - one-time and gradual:

One-time is a cut-over to your new Spreedly environment, once it is created and you have purchased a paid subscription.

Gradual is a way for you to self-manage and meter the migration if a cut-over is not convenient.

Contact Customer Support to initiate a one-time data migration.

To follow along with this guide, please log into your account at https://id.spreedly.com.

Access secrets are considered private and secure.Do not share them or expose them to insecure channels - even in e-mails to the Spreedly team.An access secret, in combination with an environment key, grants full access to the Spreedly API. If you or another user within your organization share an access secret insecurely, we advise that you revoke the secret as soon as possible, and generate a new one.

Jump to:

View your access secrets

Add a new access secret

Revoke an access secret

Share your access secrets

View your access secrets

To view your access secrets, log into your account and click on theOrganizationtab. Note that the image below isedited - when you visit your account page, no information is hidden:

add them as a user to your Spreedly account

Add a new access secret

At the bottom of your list of access secrets, there is an option to Add Access Secret:

Access secrets are randomly generated codes, but you can choose your name. Unique names can help you keep track of which access secrets you are using for your different environments or applications.

Revoke an access secret

You may revoke an access secret at any time by clicking the "Delete" button:

Deleting an access secret is permanent and cannot be undone by you, or by Spreedly. Do not delete an access secret unless you are sure you wish to do so. If production code uses the old access secret, you would need to replace it with a new access secret, or else you will not be able to accept payments.

Share your access secrets

Access secrets should never be shared over insecure, unencrypted channels. The safest way to share access secrets with individuals you trust is to . As a user, they will be able to view all of your access secrets, manage them, and create their own.

Remember that all access secrets are equal and can be used to authenticate calls in any Spreedly environment.

Spreedly Express is currently the simplest method of getting payment information into Spreedly while providing the least amount of PCI scope. If you wish to have a more customized UI with the least amount of PCI scope, use the iFrame payment form approach to collecting payment information.

There are situations where you need to send your users payment information to Spreedly using a more direct method or from a non-web source. If the iFrame payment form and Spreedly Express do not work for you, and you are willing to accept greater PCI scope, you can consider other options.

Welcome to Spreedly! If you think Spreedly is a fit for your business, sign up for a risk-free trial. You'll need to be a developer familiar with APIs or work with a developer in order to test Spreedly. We currently do not refer or recommend developers for prospects or customers for contract.

Spreedly does not currently allow testing with gateway sandboxes except in the case of Stripe, since Stripe uses the same endpoint for both production and test API calls. Spreedly has done all the testing for you in the case of all our connected gateways and we've created the Spreedly Test gateway as a result.

The Spreedly Test gateway acts and behaves just like a production gateway and supports both direct and offsite gateway functionality as well as 3D Secure and bank accounts.Once you have your integration working with test data, it should work seamlessly with production gateways and real payment types.

Required Reading

Be sure the email you use to sign-up for Spreedly is active and monitored, as it is crucial for keeping your account active and in production. All billing and account-related emails, including invoices, will go to this address.

If you have not completed testing, be aware that if you start a Spreedly subscription, you will accrue fees even if using the Spreedly Test gateway.

Any threshold monitoring and alerts will need to be done programmatically by the customer. Customers are responsible for any fees accrued on their subscriptions. Contact Customer Success if you need to get back in Trial mode to complete your testing prior to subscribing. An alternative would be to maintain two separate Spreedly accounts: one trial account for all testing, and one subscription account for your production transactions.

Read through the 4 Common Pitfalls of Testing to go to the head of the class.

We'd love to speak with you about how you intend to use Spreedly so we can provide you with the most tailored experience possible. Please contact Customer Success at any time to discuss your plans for Spreedly. We'll usually be looking for the following to start:

gateways you plan to use

monthly transactional volume estimate

what percentage of your total business you'll be bringing onto Spreedly

vaulted payment methods estimate

countries/regions where you or your customers are transacting

why you chose Spreedly

any go-live date, including any drivers such as a customer commitment

any internal constraints that may prevent go-live

You can cancel your Spreedly account at any time. You must be logged in at https://id.spreedly.com to change your subscription settings.

After you complete this process, you will no longer be charged by Spreedly.

Once your account expires, Spreedly will remove all data associated with your organization. If you return to Spreedly at a later date, you will no longer have access to this data.

Step 1: Log in

Step 2: Click the "Billing" tab.

Step 3: Stop future renewals.

Step 4: Confirm your changes.*

*Note that your subscription will remain active up until the expiration date provided in this message. After your account expires, you can no longer process payments via the Spreedly API.

To change your organization name in ID, log into https://id.spreedly.com and follow the steps below.

Note: To change the name as it appears on your invoice, please submit a request to [email protected].

Step 1: Select "Organization" tab

Step 2: Edit Organization Settings

Step 3: Edit Organization Name & Save Changes

Note: This guide only applies to customers on current pricing plans. If you are on a legacy tiered plan or a "Custom" pricing plan, please email [email protected] to change your plan.

Step 1: Log In

Log in at https://id.spreedly.com.

Step 2: Select the "Billing" tab then "Change Plans"

Step 3: Choose a plan that meets your needs

Step 4: Confirm your choice and change your plan*

* Note: Changing your plan resets your monthly billing cycle and will purchase a new subscription. We use the remaining time on your current plan as credit for purchasing your new plan. Depending on where you are in your current cycle, and how many transaction fees you owe, you might be charged for your new subscription.

It is important to have your most current e-mail address on file for your Spreedly billing notifications. If you send billing emails to an inbox that is unmonitored, or unused, you will not receive important alerts that affect your business. Spreedly will e-mail you regarding changes in your bill (upgrades & downgrades) as well as provide notifications when your credit card on file fails. Not updating your credit card information on time can lead to a lapse in service.

To avoid this, log into https://id.spreedly.com and follow these steps:

Step 1: Select the "Billing" tab

Step 2: Update your billing information

Step 3: Change where billing notifications are sent

Step 4: Submit your changes

If the change was successful, you should see confirmation on the page after clicking the "Change Email" button.

It is important to have a valid credit card on file at all times. Spreedly will e-mail you regarding changes to your bill (upgrades & downgrades) as well as provide notifications when your credit card on file fails. Not updating your credit card information on time can lead to a lapse in service. Follow the following steps to prevent your account from expiring.

Step 1: Log In

Log in to ID.

Step 2: On the Billing tab

contact Customer Success

Step 3: Change your credit card details

Step 4: Make and submit your changes

If the change was successful, you should see confirmation on the page after clicking the "Save Payment Details" button.

If the change was unsuccessful, please immediately so we can prevent your account from expiring, and instead keep you transacting.

To change the name associated with your organizations monthly Spreedly bill, log intohttps://id.spreedly.comand follow these steps:

Step 1: On the "Billing" tab

Step 2: Select change credit card details

Step 3: Changethe billing name and save

Note: You *must* re-enter your organization's credit card information as well, and click "Save Payment Details" to ensure the update is complete.

Update: Spreedly has since deprecated TLS 1.0.

When thinking about TLS 1.0, a soon to be deprecated security protocol, it's important to consider both inbound requests to Spreedly from your organization and the outbound requests that Spreedly will make to the endpoint you specify.

Inbound

In order to remain PCI compliant and a secure platform for our customers, we will be deprecating support on June 28, 2018 (in advance of the June 30, 2018 deadline). Your engineering team is likely familiar with this transition and can help develop a plan to mitigate impact to your clients. Here's some more information on why the change if you're unfamiliar: https://blog.pcisecuritystandards.org/are-you-ready-for-30-june-2018-sayin-goodbye-to-ssl-early-tls

Your development team can also check which protocol your application uses by testing your application's connection to https://https-test.spreedly.com/.

While many of our customers have upgraded to later versions of TLS, if you have mobile apps that use an iFrame, end-users could be using old versions and that's not something that we have the ability to report on. It is important to discuss with your team and be aware that transactions sent via TLS1.0 will be impacted.

Outbound

Our Core services/ActiveMerchant/Ruby use 1.2 today (if the gateway offers it).

We do not expect any problems on our side if the gateway removes support for 1.0/1.1. If your gateway already supports 1.2, Spreedly's Core service is negotiating that version today.

How do I get my clients set up with a Spreedly account?

How do I make sure that the money goes to the right merchant?

Do we have to say that we are using Spreedly?

How do I take a percentage off each transaction or split payments so that some of the money goes to my account each time?

How do I get my clients set up with a Spreedly account?

Your clients do not need a Spreedly account. All of your clients will be able to connect to their desired gateways from your Spreedly account.

How do I make sure that the money goes to the right merchant?

If you want your clients to charge their customers on your platform, youll need your clients to set up their payment gateway in your application. You have total control over how you collect the gateway specific information from your clients; whether its done directly via e-mail or through a dedicated page on your site, you can customize the flow to fit your business.

Heres one example of what that initial onboarding process might look like: http://spreedly-foodcarts.herokuapp.com/

The gateway-specific information that is required will differ from gateway to gateway, and can be found in the Spreedly gateway guides for each gateway. Your application will make a call to Spreedlys API with your clients gateway specific information, and we set up the gateway for the customer.

Heres how that looks, technically: https://docs.spreedly.com/basics/gateway/

Do we have to say that we are using Spreedly?

No, none of your clients or their customers have to know that you are using Spreedly. We are a quiet intermediary service that sits between your business and your gateways, so the only way they would know in most cases is if you told them.

How do I take a percentage off each transaction or split payments so that some of the money goes to my account each time?

We can support adding fees on top of atransaction - but only if the underlying gateway also supports it.

For example, with Stripe, we support adding fees on a transaction through the <application_fee> tag as seen here in our documentation.

Braintree allows this with the service_fee_amount field as seen here.

Digitzs also allows split payments - instructions for setting them up are in our Digitzs guide.

If you know a gateway that is supported by Spreedly also supports adding fees on top of transactions, you can send the related documentation our way, and we'll let you know if their approach is compatible with our API.

You can look up any transaction token you have on hand through the "Look Up" feature at the top of the Transactions screen on your Dashboard :

contact Customer Support

When viewing a specific transaction, at the bottom of the screen, you can tab between the transcript (communication between Spreedly and a payment gateway - not available for Spreedly-only transactions such as adding/redacting payment methods) and the JSON response body (Spreedly's response back to you after a transaction is completed).

If you find `gateway_processing_failed` or `gateway_processing_results_unknown`, your best bet is to copy the transcript and share that with the gateway so they can elaborate on why you're seeing that particular failure from them.

Check out our guide on troubleshooting for more helpful information on examining your transactions. Orif you need technical support.

Do you charge for each instance of a gateway?

My bill is higher than it should be

Do you charge for each instance of a gateway?

Many platforms have multiple merchants using the same gateway type, but every one of those merchants has a unique merchant account at that gateway. Spreedly makes it easy to route money to the right merchant account, and we made our billing for endpoint connections simple to encourage growth on your platform.

Spreedly subscription plans are based on the number of unique endpoints created. We know that larger platforms may have hundreds of merchants transacting on each endpoint, so we charge based on the number of unique endpoints you create, not based on the number of merchant accounts you add.

For more information on our pricing, please check out our pricing page.

My bill is higher than it should be

If you think that your current usage does not match up with your billing, we recommend using the Spreedly Dashboard and/or API to get an exact view of everythingyou have provisioned in your account.

Findingunneeded endpoints

Use the Spreedly Dashboardto reviewinformation about retained gateways. You can see the total number of tokens stored by gatewaytype, as well as view each individual gateway token.

Use the "list" API call to retrieve a list of all of the gateways you have currently activated in your environments. Make sure to check how many receivers you are using as well. Remember to paginate both responses so that you don't miss any data.

Somediscrepancies around pricing happen when developers are trying to test a new gateway integration. It's important to remember that there is no such thing as a true "test" environment. While itis good practice to keep one environment on your Spreedly account set up for testing, be aware that if you create a live gateway or receiver in that environment, or run a transaction on it, you will still be billed. If you are working with a team of multiple developers, make sure everyoneknows to redact any gateways or receivers you don't intend on keeping for production after they're done testing.

How to remove unneeded endpoints

Once you've identified the gateway(s) and/or receiver(s) that you don't need on your account, you should redact them.

There is a specific redact call for gateways and another one for receivers. Make sure that you remove every instance of the gateway/receiver types you do not need.

Why was my subscription upgraded?

Spreedly will automatically upgrade all accounts operating above their current subscription plan every day. If you see an invoice from us in your inbox and aren't sure why your account has been upgraded, your organization has done one (or more) of the following:

Authenticated a new, non-test gateway to one of your Spreedly environments

Authenticated a new, non-test receiver to one of your Spreedly environments

Exceeded your current storage limit for card data (Spreedly bills in increments of 5,000 on legacy plans)

Be aware that if you have a Spreedly subscription, you will accrue fees even if using the Spreedly Test gateway. Any threshold monitoring andalerts will need to be done programmatically by the customer. Customers are responsible for any fees accrued on their subscriptions. Contact Customer Success if you need to get back in Trial mode to complete your testing prior to subscribing. An alternative would be to maintain two separate Spreedly accounts: one trial account for all testing, and one subscription account for your production transactions.

Removing cards

If you'd like to clear out cards from your Spreedly vault, you can use the Spreedly API to redact payment methods. If you've got instances of duplicate cards, you can use Fingerprinting to cut back on copies and make sure all of your tokens are referencing unique cards.

Optimize your API calls for API-Based Pricing Plans

Use this guide to ensure your API calls are optimized to ensure you're not assessing unnecessary fees.

Changing your plan to match your actual usage

After you've redacted everything you don't need, you can change your plan on your own. Customers on legacy plans will need to contact us to make a plan change.

To follow along with this guide, please log into your account at https://id.spreedly.com.

An environment allows you to separate your payment information into distinct groups. Note that all environments in paid Spreedly accounts have the capability to make production transactions - there are no test-only environments.

Environments are distinct and should be used to isolate separate payment functions. You cannot use a payment method stored in environment A in a purchase against a gateway from environment B, for example.

Jump to:

Adding a new environment

Manage an existing environment

Delete an environment

Best practices for environment configuration

Adding a new environment

You can add as many environments as you like to yourSpreedly account.

To create a new environment, visit https://id.spreedly.com and click on the "Environments" tab. Below your existing environments, click on "New Environment":

Access Secrets

Clicking on "New Environment" directs you to a new page where you can name your new environment, and choose the type of payment data it will handle (don't worry - you can always change this later). If you aren't sure which type is right for you, check out the documentation linked in the description:

Clicking "Create Environment" will complete the process.

Manage an existing environment

You are able to make changes to any of your environments. From the Environments tab on https://id.spreedly.com,find the environment you want to manage and select "Configure":

From here, you can edit your environment name, change the way it can accept payment information, view access secrets and create a new signing secret for your environment:

Delete an environment

At this time, environments cannot be deleted, either by you or by Spreedly. We recommend that users wishing to abandon an environment redact all associated payment methods, gateways, and receivers, and rename the environment to denote it's no longer being used.

Best practices for environment configuration

Customers generally set up their Spreedly account in one of two ways:

One production environment with multiple gateways

Multiple production environments with one gateway per environment

There arepros and cons to both, however you get the most benefit out of Spreedly if you implement the first way. Since Spreedly allows you to universally vault payment method information, having those payment methods within one production environment allows you to use them with any gateway in that environment. That means easy switching for failover and backup purposes, as well as keeping your code streamlined.

You can do the same with your .

Sample Apps

iFrame Payment Form

Embed a Spreedly-delivered form into your payment page to collect payment data and store it securely with Spreedly. Your app never touches sensitive data.

GitHub Source

Running Application

Spreedly Express

Prompt for the users payment data with a Spreedly-designed overlay. Ideal for charging one-time customers, but can be adapted to save customer payment details for returning customers.

GitHub Source

Running Application

Spreedly API

Integrate your app directly with Spreedlys API, maintaining complete control of the user experience. This app demonstrates making one-time purchases through Spreedly. Using Spreedlys API will increase your PCI scope compared with Spreedly Express and iFrame.

GitHub Source

Running Application

Multiple payment providers APIs

Give your users choice in payment method by integrating with third party tools. This app demonstrates processing payments through Spreedly, PayPal, and other providers.

GitHub Source

Running Application

To use Spreedly, you need great developers. One question we therefore often here is: are there third party developers we can work with to help launch our app? This guest post was written by the AppInstitute team.

AppInstitute provides a simple way for small businesses to create, publish and manage their own iPhone and Android app using a DIY app builder platform, making entering the app market easy for even the least tech-savvy small business owner.

View the full case study on the Spreedly blog.

Billing is a highly sensitive customer touch point and it is more pronounced when you try to charge hundreds of customers every month at varied price points and discounts. Chargebee helps online businesses deliver an accurate & automated recurring billing in the cloud.

Chargebee focuses on all the nuances of automated subscription billing while allowing customers to have peace of mind with security, mobile compatibility and the assurance of having an extended billing team to support and take your business through high growth.

View the full case study on the Spreedly blog.

Equiant is a leading provider of receivable servicing technology solutions. Its clients include timeshare, equipment rental, and other portfolio holders in structured finance. For these kinds of customers, the ability to efficiently manage relations with the end-clients in their portfolio is vital.

Equiant provides its customers with the infrastructure needed to manage their portfolios. Both by outsourcing its technology and through outsourced services. One of the key business processes that its technology enables is the processing of payments. That includes critical payments functionality like periodic invoicing and subscriptions.

View the full case study on the Spreedly blog.

Pin Payments is Australias only all-in-one programmable multi-currency payment system.

Grant Bissett is Pin Payments co-founder and product manager. Below he explains how Spreedly is helping them to change the payments industry in their corner of the world.

View the full case study on the Spreedly blog.

SeatGeek uses Spreedly to store credit card data while remaining Level 1 PCI Compliant. People visit SeatGeek to purchase event tickets from one of their hundreds of affiliate companies. SeatGeeks goal has always been to allow the user to buy tickets in a seamless way without leaving the SeatGeek check out, while still being able to take advantage of each of their affiliates inventory.

Before integrating with Spreedly two-and-a-half years ago, SeatGeek didnt have a system for storing payment information, due in part to the daunting processes involved with Level 1 PCI compliance. That meant users had to enter their payment information each and every time they visited the SeatGeek site not an ideal situation, particularly for retaining regular customers.

Russell DSouza, SeatGeeks founder, wanted to find a more elegant payment solution for his users, and thats where Spreedly came in.

View the full case study on the Spreedly blog.

Alex Henderson, principal engineer at Pushpay, took the stage at PAYMENTSfn to talk through how Pushpay ensures payment resiliency. Pushpay helps churches grow their community by facilitating tithes, gifts, and other payments and helping the church to engage with their members. Early in its development, Pushpay dealt with multiple gateways either directly or through Spreedly. It offered a single payment method, and, when Alex joined, was processing about $1M in gifts per year for its customers. They're now processing about $3B per year and support ACH and other payments. And they use Spreedly for all credit card processing communications to gateways.

View the full case stud y on the Spreedly blog.

View the full case study here.

View the full case study here.

Non-profits perform vital good works in their communities -- and around the world. But to achieve their goals, they usually need money. A non-profit without an effective fundraising program simply can't fulfill its mission.

CEO Justin Wheeler joined Nathaniel Talbott to talk through payments in the context of fundraising and non-profits.In their wide-ranging conversation, they talk about the specific payments challenges non-profits face and how payments strategies like subscriptions, choosing the right payment methods, and "add-on" donations can help non-profits hit their fundraising goals.

View the ful l case study on the Spreedly blog.

View the full case study here.

Did you know that much of Spreedly's early stage growth came from our customers ' word-of-mouth? The testimonials on the bottom of that page are invaluable to us. The benefits that using Spreedly has provided for their businesses was clear enough that they wanted to share it with other organizations in their networks.

In fact, our customers are the driving force behind our annual conference for payments engineers, PAYMENTSfn. The passion our customers have for what we do inspires us to keep building an amazing product for them.

How has Spreedly provided value for your business since you implemented us? Do you want to show off your developer expertise and team up on a testimonial or case study? Contact Customer Success and we can chat about ways to partner on this.

Spreedlys Vault Manager gives you the ability to organize and understand the card assets in your Spreedly vault which can be critical to informing strategic decision-making for your business.

You may want to organize cards to identify:

Which cards belong to which merchants?

How many active cards are there on your Silver pricing plan?

Which industry vertical represents the best target for upsell based on volume of subscribed cards?

To start using Vault Manager, simply attach relevant business attributes to any card. You can do this when adding or updating a payment method in your Spreedly vault by defining a custom metadata key (like customer_id, customer_segment, geography, currency, pricing_plan, etc.) and populate it with any string value.

Request Body API documentation

Metadata key-value pairs are currently limited to 25 and keys are limited to 50 characters. Values are limited to 500 characters and cannot contain compounding data types. However, when using the list call, you can query for cards that match one or more metadata values to better segment and analyze card assets by any business criteria important to your organization.

If you find that the initial limits imposed on this feature are not sufficient for your business, please contact our Customer Success team and wed be happy to discuss your use case.

Coming soon, well be adding the ability to leverage card metadata downstream in the Spreedly application to enrich insights into transactions and more.

See the for implementation details and get started today.

Subscribe to the Spreedly changelog: https://docs.spreedly.com/changelog/

Subscribe to the Spreedly blog: https://www.spreedly.com/blog

Follow Spreedly on Twitter: https://twitter.com/spreedly

You can run unlimited transactions with test cards against our test gateway on your free trial. But, if you want to workend-to-end with a live gateway and start collecting your customers' payment information with Spreedly, you will need to activate your Spreedly account by purchasing a subscription that fits your usage.

To do this, log into your Spreedly account and navigate to the Billing tab:

Quick Start guide

Once you click "Pick a plan for your organization", you will be directed to a pricing page, where you can choose a plan that fits your needs. Once you've picked your plan, you'll be prompted to enter your credit card information. If there are no problems with the transaction, you will have successfully activated your Spreedly account.

Required Reading

Be sure the email you use to sign-up for Spreedly is active and monitored, as it is crucial for keeping your account active and in production. All billing and account-related emails, including invoices, will go to this address.

If you have not completed testing, be aware that if you start a Spreedly subscription, you will accrue fees even if using the Spreedly Test gateway.

Any threshold monitoring and alerts will need to be done programmatically by the customer. Customers are responsible for any fees accrued on their subscriptions. Contact Customer Success if you need to get back in Trial mode to complete your testing prior to subscribing. An alternative would be to maintain two separate Spreedly accounts: one trial account for all testing, and one subscription account for your production transactions.

We'd love to speak with you about how you intend to use Spreedly so we can provide you with the most tailored experience possible. Please contact Customer Success at any time to discuss your plans for Spreedly. We'll usually be looking for the following to start:

gateways you plan to use

monthly transactional volume estimate

what percentage of your total business you'll be bringing onto Spreedly

vaulted payment methods estimate

countries/regions where you or your customers are transacting

why you chose Spreedly

any go-live date, including any drivers such as a customer commitment

any internal constraints that may prevent go-live

If you want to get started right away, check out our .

If you want your clients to charge their customers on your platform, youll need your clients to set up their payment gateway in your application. You have total control over how you collect the gateway specific information from your clients; whether its done directly via e-mail or through a dedicated page on your site, you can customize the flow to fit your business.

Heres one example of what that initial onboarding process might look like: http://spreedly-foodcarts.herokuapp.com/

The gateway-specific information that is required will differ from gateway to gateway, and can be found in the Spreedly gateway guides for each gateway. Your application will make a call to Spreedlys API with your clients gateway specific information, and we set up the gateway for the customer.

Heres how that looks, technically: https://docs.spreedly.com/basics/gateway/

Copies of your invoice can be found by logging into https://id.spreedly.com.

Select the Billing tab:

Follow the link to view past invoices:

You can view previous invoices by following the hyperlinks provided near the bottom of the page:

Each invoice will appear stylized as follows. Please note that we do not provide PDF or hard copies of invoices. Customers who require copies of invoices for accounting purposes should save their invoice as an image or download the web page as a PDF.

https://docs.spreedly.com/reference/api/v1/

https://docs.spreedly.com/reference/express/v2/

https://docs.spreedly.com/reference/iframe/v1/