Quickbooks Payment Gateway
The QuickBooks payment gateway will allow your attendees/registrants to pay for their event registration with a credit card or debit card.
Setup and Configuration
A QuickBooks account is needed to accept payments via QuickBooks. Need an account? Sign-up for a QuickBooks merchant account to get started.
A dedicated SSL certificate is recommended to make registration checkout and other areas of your website more secure.
Through this documentation, we’ll be mentioning “QuickBooks” and “Intuit.” Note that QuickBooks is a brand by Intuit. It includes several services including accounting products, payment processing, and more. This payment gateway add-on will allow you to accept credit and debit cards through the QuickBooks payment processing service.
Login to your Event Smart dashboard and go to Event Smart –> General Settings –> Payment Methods. Once on the Payment Methods screen, click on QuickBooks and click on the button to activate the payment method.
Below are the available fields and explanations for each field.
Name – This is the name of the payment method.
Description – This description is shown during registration checkout.
Admin-Only Name – This is a name of the payment method that will only be shown in the Event Smart dashboard.
Admin-Only Description – This description is used only in the Event Smart dashboard.
Debug Mode On? – Enables debugging for this payment method. It should be off (set to no) on a live/production site.
Open by Default? – This sets this payment method to be pre-selected on the registration checkout page.
Company ID – A unique identifier for your company.
App Token – A unique token for your app that you create through the Intuit Developer portal.
OAuth Consumer Key – This is generated when you create your app through the Intuit Developer portal.
OAuth Consumer Secret – This is generated when you create your app through the Intuit Developer portal.
Button URL – This is the URL to the image that will be used during the payment process of registration checkout.
Alternative Button URL: http://ee-screenshots.s3.amazonaws.com/2015/07/pay-by-credit-card.png
Usable From? – Select where this payment method should be available for use. This payment method cannot process payments through the Event Smart dashboard.
PMD Order – The value (number) can be used to sort or arrange this payment option. A lower value means that it should appear first during registration checkout.
Update Settings – Click this button after making any changes to your payment method.
Deactivate Payment Method – Click this button to deactivate this payment method.
Locate your Credentials for QuickBooks
Getting QuickBooks setup requires multiple steps including creating an app through the Intuit Developer portal, entering the credentials for your merchant account in the payment methods screen for Event Smart, and then authorizing the app to allow processing of payments.
We recommend that you first read through the steps below before getting started. This will help ensure that your QuickBooks payment method is setup correctly.
Begin by going to the Intuit Developer website: https://developer.intuit.com
1) If you have an existing login for the Intuit Developer dashboard, then go ahead and login to the Intuit Developer website. If you do not have an existing login, then register and complete that process entirely and then login to your new account.
2) Look for the button that says Create new app and click on it
3) A window will then appear with two options. Look for Just Start Coding and click on theSelect APIs button.
4) You will see another screen with two more options. Look for the Payments option and theQuickBooks option and place a checkmark next to each option and then click on the Create app button
5) Your app will be created within a few seconds and then you’ll see the dashboard screen for your app.
Update your Account Profile
Look for your account name / email address in the top right area of the screen and click on it and then click on Profile. Now update the information and save changes by clicking on the Savebutton. If your email address has not yet been verified, then go ahead and verify it.
Your merchant account with QuickBooks should already be approved for accepting live payments. If you are not sure, then we recommend that you check with the support team at QuickBooks to confirm the status of your merchant account.
Create your Development (Testing) App
1) Click on the Development link from your Intuit Developer screen and then click on Settings. From this page, we’ll update some important information. Take your time to carefully update this information.
2) Click on APIs and place a checkmark next to QuickBooks and then Payments. Both should be checked. Then click Save.
3) Click on App Info and change the Application Name to something more memorable and easy to recognize such as “Testing app for QuickBooks” and click Save.
4) Now click on App URLs and then enter the information about your website. You should update the Host Domain, Launch URL, and Disconnect URL and then click Save.
Here are suggestions for the URLs to use:
Host Domain –> Your actual domain name (e.g. yourwebsite.com)
Launch URL –> Your actual domain name (e.g. yourwebsite.com)
Disconnect Landing URL –> Your actual domain name (e.g. yourwebsite.com). Your app can be disconnected and reconnected through your QuickBooks payment methods page within your Event Smart dashboard.
Connect your Development (Testing) App to Event Smart
We recommend testing QuickBooks before accepting payments in live / production mode. Follow the steps below to connect your testing app to Event Smart.
1) Click on the Development link from your Intuit Developer screen and then click on Keys. From this page, you’ll be able to retrieve the App Token, OAuth Consumer Key, and OAuth Consumer Secret
2) Open a new browser tab and login to your Event Smart dashboard and go to Event Smart –> Payment Methods and then click on QuickBooks. Then click the button to activate the payment method for QuickBooks
3) Look for the Turn Debug Mode setting and set it to Yes
4) Now switch back to your other browser tab that has your App Token, OAuth Consumer Key, and OAuth Consumer Secret and carefully copy and paste each into the respective fields (in your other browser tab)
5) We now need to lookup the Company ID. Look in the top right area of your browser tab for the Intuit Developer page (where you see your credentials above above on the Intuit website) and then click on your account name / email address and then click on Sandbox.
6) Look for the option that says “Test your app with more global QuickBooks companies” and click on Add and allow it a few moments for your sandbox (testing) company to be created. Under the company name you will see the Company ID. Copy the Company ID.
7) Switch to your other browser tab that has the payment methods screen for QuickBooks and then paste in the number into the Company ID field
8) Scroll down and click on the Update Payment Method Settings button
9) The page will refresh and you’ll see a note about establishing the app connection. Look towards the top area of the payment methods settings area for a green and white QuickBooks button and click on it
10) A window will appear and ask you to login. If you do not see a window, then your web browser may be blocking the pop-up window. Allow pop-ups in your web browser and try again. If you still do not see the pop-up, then try logging into your Event Smart dashboard and returning to the payment methods screen for QuickBooks through an alternative web browser (e.g. Chrome, Opera, Firefox).
Login securely using the same credentials that you used for the Intuit Developer site where your app was originally created. You may be asked to verify the account through email or another step. Go ahead and verify the account if requested.
11) You will then see a prompt to authorize the connection between your site and QuickBooks. Go ahead and click on the Authorize button. If you have multiple test companies, then select the correct company and complete the authorization.
12) Double-check that you now see a Connected status of green in the Connect to QuickBooks section of the payment methods screen.
You can now begin testing QuickBooks for Event Smart. We recommend creating a real event and then saving it as a draft. Then duplicate it through the event editor and update the name of the event to TEST or something easily recognizable. This will allow you to test out registrations for your event without adding sample/test registration records to your “real” event.
Once you are finished testing, then you can trash the “testing” event and disconnect the testing/development app through Event Smart –> Payment Methods –> QuickBooks –> Connect to QuickBooks. Then click on the Disconnect button.
Then follow the steps in the next section to create your live app for accepting real payments with actual funds.
Create your Production (Live) App
1) From your Intuit Developer dashboard, click on Production . If you completed your account profile and verified your email address, then you will see a screen to share information about your app.
If you have not updated your account profile and verified your email, then you will see a pop-up appear to begin those steps. Place a checkmark in the terms and conditions box and then click on the link for complete your account profile and verify your email address. Go ahead and update your profile with your information and then save changes. Next, go to your email inbox and click to verify your email address. Once you have updated your profile and verified your email address, then go to step 2 below.
2) From your Intuit Developer dashboard, click on Production and this time, you’ll see a different screen. It will ask you to complete several fields. Change the Application Name to something more memorable and easy to recognize such as “Live app for QuickBooks.” Then enter your Host Domain Name (e.g. yourwebsite.com) and then complete the remaining fields for End User License Agreement URL, Launch URL, Privacy Policy URL, and Disconnect Landing URL.
Here are suggestions for the URLs to use:
End User License Agreement URL –> Your actual domain name (e.g. yourwebsite.com)
Launch URL –> Your actual domain name (e.g. yourwebsite.com)
Privacy Policy URL –> A link to your privacy policy on your own site (e.g. yourwebsite.com/privacy-policy/).
Disconnect Landing URL –> Your actual domain name (e.g. yourwebsite.com). Your app can be disconnected and reconnected through your QuickBooks payment methods page within your Event Smart dashboard.
In the next section, leave your country selected and accept the terms and conditions by placing a checkmark in the box. Then click on Save.
Connect your Production (Live) App to Event Smart
We recommend that you test payments in QuickBooks using your development (test) app. If you have skipped those steps, then we recommend going to the prior section above and setting up a testing app and connecting it to Event Smart.
Then follow the steps below when you are ready to accept production (live) payments.
1) Click on the Production link from your Intuit Developer screen and then click on Keys. From this page, you’ll be able to retrieve the App Token, OAuth Consumer Key, and OAuth Consumer Secret
2) Open a new browser tab and login to your Event Smart dashboard and go to Event Smart –> Payment Methods and then click on QuickBooks. Then click the button to activate the payment method for QuickBooks
3) Look for the Turn Debug Mode setting and set it to No
4) Now switch back to your other browser tab that has your App Token, OAuth Consumer Key, and OAuth Consumer Secret and carefully copy and paste each into the respective fields (in your other browser tab)
5) We now need to lookup the Company ID. There are two ways to locate your Company ID which will be an alpha numerical value. You can login to your QuickBooks merchant account such as through the QuickBooks Online Login portal and then press the following keys on your keyboard: Control + ALT + ?. If you are not able to retrieve the Company ID, then please follow up with QuickBooks support and they will be able to help you.
6) Once you have your Company ID, then go ahead and copy it and then switch to your other browser tab that has the payment methods screen for QuickBooks and then paste in the number into the Company ID field
7) Scroll down and click on the Update Payment Method Settings button
8) The page will refresh and you’ll see a note about establishing the app connection. Look towards the top area of the payment methods settings area for a green and white QuickBooks button and click on it
9) A window will appear and ask you to login. If you do not see a window, then your web browser may be blocking the pop-up window. Allow pop-ups in your web browser and try again. If you still do not see the pop-up, then try logging into your Event Smart dashboard and returning to the payment methods screen for QuickBooks through an alternative web browser (e.g. Chrome, Opera, Firefox).
Login securely using the same credentials that you used for the Intuit Developer site where your app was originally created. You may be asked to verify the account through email or another step. Go ahead and verify the account if requested.
10) You will then see a prompt to authorize the connection between your site and QuickBooks. Go ahead and click on the Authorize button. If you have multiple live companies, then select the correct company and complete the authorization.
11) Double-check that you now see a Connected status of green in the Connect to QuickBookssection of the payment methods screen.
You are now ready to start accepting live payments! If you were previously testing QuickBooks and duplicated a “testing” event then be sure that event is un-published or in the trash. This will ensure that it is not available for registration by your registrants/attendees.
App Expiry Date
You can reset the expiry by going to Event Smart –> Event Smart –> Payment Methods. Then click on QuickBooks and look for the Connect to QuickBooks area and click on the Disconnect button. Then click on the Connect button and then login. You may be asked to verify your account. Go ahead and do so and then click on the name of the company and finally click Authorize.
Afterwards you should see a green connected status with the updated expiry date. This expiry period of 6 months comes from QuickBooks and is not something that is set by Event Smart.
Usage
The QuickBooks payment gateway will let you accept payments via major credit or debit cards. ACH (bank transfer) payments are not supported.
This is an onsite payment gateway which means that attendees/registrants will process their payment on your site.
A QuickBooks account is needed to accept payments via QuickBooks and an SSL certificate is recommended for securing your website.
Troubleshooting
I configured QuickBooks and payments are not being processed. Can you help?
Double-check your credentials to make sure that you are using the production / live credentials which are for production mode. Also, ensure that there is no extra spacing before or after the credentials in the payment methods page of Event Smart.
Are ACH (bank transfer) payments available?
Credit and debit card payments are available through the QuickBooks payment gateway for Event Smart 4.
How can I setup a recurring payment or subscription through QuickBooks?
Recurring or subscription payments are not currently supported in the EE4 QuickBooks payment gateway.
When I refund a payment, does it also refund through QuickBooks?
Refunds in Event Smart 4 are currently a two step process. First, apply the refund through the transactional details screen of Event Smart in your Event Smart dashboard. Then login to your QuickBooks account and process the refund.
Is an SSL certificate needed for QuickBooks?
A dedicated SSL certificate is recommended if you are accepting payments on your website.
Do I need to be PCI compliant?
Compliance with the Payment Card Industry Data Security Standards (PCI DSS) is required if you are processing, storing, or transmitting credit card data.