Spreedly
  • 26 Mar 2024
  • 7 Minutes to read
  • Dark
    Light

Spreedly

  • Dark
    Light

Article summary

Payment Gateway Customer Record Update

Since Spreedly does not have an equivalent record (ex. user id) for customers, a Payment Gateway Customer record will not be created in Salesforce.

Spreedly is a service that allows you to securely store credit cards and use them to perform transactions for a number of PaymentGateways and third-party APIs. It does this by simultaneously providing a card tokenization/vault service as well as a gateway and receiver integration service. PaymentMethods tokenized by Spreedly are stored at Spreedly, allowing you to independently store a card and then pass that card to different endpoints based on your business requirements. We refer to the ability to use a Spreedly token against multiple gateways/end points as “universal tokenization.”

To read more about Spreedly, click here.

Spreedly Payment Gateways

Supported and Fully Tested

  • Cybersource via Spreedly

Used by Blackthorn Customers, but Not Fully Tested

  • Braintree
  • Cardconnect
  • Elavon
  • eWAY
  • Fat Zebra
  • Litle
  • Orbital
  • Payflow Pro
  • Paypal
  • Sage

Not Supported

  • Worldline

What is the fee per transaction when using PayPal as a payment gateway?
The fee per transaction when using PayPal as a payment gateway is 3.49% + a flat fee depending on the country. The flat fee for the USA is 0.49 USD (standard rate).

Set Up the Payment Gateway Page Layout

Payment Gateway Customer Record Update
Since Spreedly does not have an equivalent record (e.g., user id) for customers, a Payment Gateway Customer record will not be created in Salesforce.
  1. Click the Gear icon in the upper right-hand corner.
  2. Click Setup.
  3. Click the Object Manager tab.
  4. Locate the Payment Gateway object.
  5. Click the Field & Relationships tab.
  6. Locate the Provider field.
  7. In the Values section, click New.
  8. Enter “Spreedly” and click Save.
  9. Click the Page Layouts tab.
  10. Click Payment Gateway Layout.
  11. Add the following fields to your Payment Gateway page layout:
    • Spreedly Environment Key
    • Spreedly Configured Gateway
    • Gateway Token
  12. Click on the Buttons section. 
  13. Drag and drop the Create Spreedly Gateway button to the Custom Buttons section.
  14. Click on the Mobile & Lightning Actions section.
  15. Drag and drop the Create Spreedly Gateway button to the Salesforce Mobile and Lightning Experience Actions section.
  16. Click Save.

Complete the following steps to set up Braintree.**
  1. Gather the following details from your Braintree account.
    • Merchant Account Id
    • Merchant Id
    • Public Key
    • Private Key
  2. After logging in to Braintree, go to Settings.
    • The Merchant Account Id and Merchant Id can be found on the Business Tab, under Merchant Accounts.
    • The Public Key and Private Key are on the API tab under Keys.
  3. On the Spreedly gateway record, click the Create Spreedly Gateway button.
  4. Select Braintree from the list of gateways.
  5. Change the Auth Mode to Blue.
  6. Enter the details gathered above into the matching fields.

**Braintree is used by some Blackthorn customers, but Blackthorn does not officially support Braintree. Use at your own risk.

Virtual Terminal Custom Setting

Before using Spreedly with Cybersource to accept payments, the Virtual Terminal custom setting Show Address must be enabled. This ensures that the address fields (Street, City, State, and Country/Region) will be visible on the Payment Method creation page in the Virtual Terminal.

Spreedly_VT_Show%20Address_Custom%20Setting

Add A Spreedly Payment Gateway

Authorize.net and Stripe Users

When setting up a Payment Gateway using Spreedly, the option to add Authorize.net and Stripe as a Payment Gateway has been removed. Authorize.net and Stripe function as stand-alone Payment Gateways.

  1. Contact Blackthorn Support to obtain a Spreedly Environment Key.
  2. Navigate to the Payment Gateway object.
  3. Click New.
  4. Enter a Payment Gateway Name.
  5. Set Provider = “Spreedly”.
  6. Check the Test Mode checkbox if you are setting this up in your sandbox for testing. Do not check the box if this is a Live Payment Gateway in production.
  7. Populate the Default Currency and Default Country fields.
  8. Enter the key provided by Blackthorn Support in the Spreedly Environment Key field.
    Spreedly New PG
  9. Click Save.
  10. Click the Create Spreedly Gateway button.
  11. Select the Payment Gateway you want to connect (Ex. CardConnect; EBANX). For test mode, select "Spreedly Test".
  12. If prompted, add additional information from the selected gateway.
  13. Click Create.
  14. The Spreedly Configured Gateway and Gateway Token fields will be populated automatically.

Add a CyberSource Payment Gateway

  1. Contact Blackthorn Support to obtain a Spreedly Environment Key.
  2. Navigate to the Payment Gateway object.
  3. Click New.
  4. Enter a Payment Gateway Name.
  5. Set Provider = “Spreedly”.
  6. Leave the Test Mode checkbox blank. Only check if you are setting this up in your sandbox for testing. 
  7. Populate the Default Currency and Default Country fields.
  8. Enter the key provided by Blackthorn Support in the Spreedly Environment Key field. Spreedly New PG
  9. Click Save
  10. Click the Create Spreedly Gateway button. 
  11. Select the CyberSource Payment Gateway.
  12. Enter the Transaction Key and Username.
    • Use the SOAP toolkit key you created in Cybersource as the Transaction Key. 
    • Use the Merchant ID from CyberSource as the Username. (Where do I find the Merchant ID?)
  13. Click Create
  14. The Spreedly Configured Gateway and Gateway Token fields will be populated automatically.

Test Spreedly

Test your Payment Gateway using either the test Spreedly card or the test Spreedly ACH bank account.

Test a Spreedly Card

Warning
Real card and bank account information cannot be used in Test Mode.
  1. Confirm that the Payment Gateway has Test Mode set to “TRUE”.TestPGSpreedly_TestMode
  2. Go to the Payment Method tab and click New.
  3. Select Card and click Next.TestPGSpreedly_NewPM
  4. Using the information provided below, complete the following fields.
    • Holder’s Name = use any name
    • Number = “4111111111111111”
    • Expiration Month = use any month
    • Expiration Year = use any year
    • CVV = use any 3-digit number
    • Postal Code = use any 5-digit number
    • Payment Gateway = use the Payment Gateway you just set up
  5. Click Save.TestPGSpreedly_PaymentMethod

This Payment Method is now valid and can be used to capture and refund Transactions.

For more information about testing Spreedly Payment Gateways, click here

Spreedly and ACH Bank Account Limitation

Blackthorn does not support webhook callbacks for gateways that are configured through Spreedly. As a result, Blackthorn does not recommend submitting ACH payments via Spreedly. 

If an ACH payment is submitted via Spreedly, users must check their gateway to see if the payment is complete. Users cannot confirm if the payment was successful by going to Salesforce. 

If you do use ACH payments with Spreedly, please proceed with caution.

Test a Spreedly ACH Bank Account

Warning
Real card and bank account information cannot be used in Test Mode.

  1. Confirm that the Payment Gateway has Test Mode set to “TRUE”.TestPGSpreedly_TestMode
  2. Go to the Payment Method tab and click New.
  3. Select ACH and click Next.TestPGSpreedly_NewPM
  4. Using the information provided below, complete the following fields.
    • Holder’s Name = use any name
    • Account Number = “9876543210”
    • Routing Number = “021000021”
    • Account Holder Type = either option
    • Currency ISO = “USD”
    • Country ISO = “US”
  5. Click Save.

This Payment Method is now valid and can be used to capture and refund Transactions.

For more information about testing Spreedly Payment Gateways, click here.

Create Credit Card Payment Methods

LIMITATION

If you create a new Payment Method for a Spreedly gateway by clicking the New button on the Payment Method List view, the new Payment Method will be saved, but the Payment Method Status will not be updated to “Valid” or “Invalid.”

From the Payment Method Object

  1. Navigate to the Payment Method object.
  2. Click New.
  3. Set Record Type = "Card"
  4. Fill in the following fields.
    1. Holder's Name
    2. Account Holder Type
    3. Currency ISO
    4. Country ISO
  5. Set Payment Gateway = “Spreedly”.
  6. Click Save.

From the Virtual Terminal

  1. Navigate to an object or record where you can access the Virtual Terminal (Opportunity, Invoice, etc..)
  2. Set Action = "New Payment Method".
  3. Set Payment Gateway = “Spreedly”.
  4. Click the CREDIT CARD tab.
  5. Fill in the following fields.
    1. Name on card
    2. Card number
    3. Card Expiration
    4. CVC
    5. Postal code
  6. Click Add +.

Create ACH Payment Methods

Spreedly and ACH Bank Account Limitation

Blackthorn does not support webhook callbacks for gateways that are configured through Spreedly. As a result, Blackthorn does not recommend submitting ACH payments via Spreedly. 

If an ACH payment is submitted via Spreedly, users must check their gateway to see if the payment is complete. Users cannot confirm if the payment was successful by going to Salesforce. 

If you do use ACH payments with Spreedly, please proceed with caution.

From the Payment Method Object

  1. Navigate to the Payment Method object.
  2. Click New.
  3. Set Record Type = "ACH".
  4. Fill in the following fields.
    1. Holder's Name
    2. Account Holder Type
    3. Currency ISO
    4. Country ISO
  5. Set Payment Gateway = “Spreedly”.
  6. Click Save.

From the Virtual Terminal

  1. Navigate to an object or record where you can access the Virtual Terminal (Opportunity, Invoice, etc..)
  2. Set Action = "New Payment Method".
  3. Set Payment Gateway = “Spreedly”.
  4. Click the BANK tab.
  5. Fill in the following fields.
  6. Name on account
  7. Account holder type
  8. Routing Number
  9. Account number
  10. Click Add +.

Process a Payment

Spreedly and DocumentLink

Blackthorn Payments does not support using DocumentLink to make a payment with a Spreedly Payment Gateway.

From the Transaction Object

  1. Navigate to the Transaction object.
  2. Click New to create a new record.
  3. Select the "Charge" for the Record Type.
  4. Enter the amount in the Amount field.
  5. Select your Payment Gateway.
  6. Select the Payment Method.
  7. Click Save.
  8. Click Capture to charge the Transaction..

From Virtual Terminal

  1. Navigate to an object or record where you can access the Virtual Terminal (Opportunity, Invoice, etc..)
  2. Set Action = "New Single Charge".
  3. Set Payment Gateway = “Spreedly”.
  4. Fill in the following fields.
    1. Related To
    2. Payment Method
    3. Amount
    4. Currency
    5. Process Type
  5. Click Process.

How Do eChecks Work With Spreedly?

Customers can create ACH Payment Methods with Spreedly that can be used with a gateway's eCheck service. See more details about the eCheck gateways that Spreedly supports here.

When using eChecks, with the exception of an offsite gateway like PayPal, the response for eChecks will always be successful on Spreedly's end. Otherwise, the notification will happen outside of Spreedly. If a Transaction fails, the gateway user will be notified, and they will need to update the Transaction in Salesforce.


What's Next