The Beanstream payment gateway connects to the Canadian-based online payment card processor Beanstream. Beanstream provides payment card processing services for merchants operating in both the US and Canada. The Beanstream gateway provides a seamless onsite checkout process where the customer stays on your website throughout the entire transaction.


Getting Started

To get started, you will first need a Beanstream processing account. You can apply for a beanstream account here:

You will need the following information before you start setting up your Beanstream account:

  1. API Username
  2. API Password
  3. Merchant ID

[up to contents]

Obtain API Credentials

When your Beanstream account is approved and successfully set up, you will need to locate the following information:

  1. The API Username assigned to your account.

    Careful here. This is different than a normal user account. This particular username setup can be found in Administration->Account Settings->Order Settings->Transaction Validation Options.

    Check the box for "Use username/password validation against transaction" and enter a username/password of your choice. Then, click "Update" at the bottom of the screen to save your changes.

  2. The API Password assigned to your account.

    The API Passwode setup can be found in your Beanstream account in Configuration->Payment Profile Configuration->Security Settings.

    Select the "API access passcode" option. If a passcode isn't already set, click "Generate New Code". Then, click "Update" at thebottom of the screen.

  3. The Merchant ID assigned to your account.

    Beanstream identifies merchants by their unique 9-digit identifier (the one provided by email at sign-up). If you’ve signed up for more than one service or processing currency, you may have been issued multiple ID numbers. You must complete separate integrations for each ID number that you have been issued.

    The merchant id may be found in the upper right hand corner of the screen in your Beanstream account

[up to contents]

Payment Gateway Configuration

To configure your Payment Gateway, you only need to do 2 things; navigate to the Payment Setup and enter your Payment Gateway credentials.

First, navigate to the Payment Setup section of the module:

Select the Beanstream option from the Payment Gateway dropdown:

The following fields will be displayed:

Enter your Payment Gateway Credentials:

  • API Username: API Username you acquired in the previous step.
  • API Password: API Password you acquired in the previous step.
  • Merchant ID: Merchant ID you acquired in the previous step.

If you're using the Test environment, enable Test Mode by checking the Test Mode checkbox:

Save the settings

[up to contents]


Your account will initially start in a test mode. You’ll be able to view the transaction process from beginning to end without sending real information to the banking network. These numbers will not be valid on live accounts. If you wish to run tests on an integration and your account is already live, contact Beanstream to request a separate “sandbox” account for your company. While your account is in test mode, Beanstream will only process specific test credit card numbers.

  • Visa – Use CVD/CVV code 123
    • Approved 4030000010001234
    • Approved $100 Limit 4504481742333
    • Approved VBV 4123450131003312 with VBV passcode 12345
    • Declined 4003050500040005
  • MasterCard – Use CVD/CVV code 123
    • Approved 5100000010001004
    • Approved 5194930004875020
    • Approved 5123450000002889
    • Approved 3D Secure 5123450000000000 passcode 12345
    • Declined 5100000020002000
  • American Express – Use CVD/CVV code 1234
    • Approved 371100001000131
    • Declined 342400001000180
  • Discover – Use CVD/CVV code 123
    • Approved 6011500080009080
    • Declined 6011000900901111

[up to contents]

Add Feedback