Quickbooks Payments API setup

With the new QuickBooks Payments, new and existing customers alike will be required to setup an "app" for their company, as a connector between the storefront and their merchant account. Here are the steps to work through this process:

NOTE: Due to the need for multiple tabs in the same browser and working among them, it is highly recommended to use a computer rather than a mobile device to perform this setup.

1.  You will need to first create an Intuit developer account for Quickbooks Payments:
   https://accounts.intuit.com/signup.html?offering_id=Intuit.devx.devx
   
   NOTE: After you have an account created, you can sign in later here (bookmark this page):
   https://developer.intuit.com/app/developer/homepage


2. Verify the account email by clicking the "Verify My Email" link in the email sent to you by the signup page if you were sent one. If you have an existing Intuit account with the email you signed up for the dev account through, you may already have it verified.


3. Click the terms checkbox and Create Account button.


4. Now you need to create an "app". Click on the top menu "My Apps".


5. Click on the link upper right "+ Create an app".


6. Select the "QuickBooks Online and Payments" platform option.


7. Give your app a name "What's your app name?", typically your company name.


8. Select a scope: Payments


9. Click the "Create app" button.


10. You should now be in your new app, likely seeing "Develop your app" heading. If you are not in your app, go to My Apps and click on the app name you created.


11. On the left menu, click on "Production".


12. In the "Terms of Service Links", enter the URLs for your Terms or Security, and Privacy topic pages on your storefront site.

example: https://www.yourstore.com/topic/termsandconditions_main

example: https://www.yourstore.com/topic/privacy


13. Select a "Target industries for this app" ( None of the above typically)


14. Select the "Countries you accept connections from" ( just United States likely ), Click the SAVE button.


15. Still on the app "Production" page, click on the left menu "Keys & OAuth".


16. If you have not completed the required app setup steps, there will be a list of those items to complete first, such as the Account Profile. Click any incomplete links and complete them.


17. Return to your app "Keys & OAuth" page (My Apps - click your app name - click the Production - Keys & OAuth link left menu)


18. You should now have a Production Client ID value, and a Client Secret value.


19. Below the Keys area is "Redirect URIs" . Click the "Add URI" button, and enter the following URI using YOUR site domain and the value in your site Configuration - Settings - AdminDir setting. You may want to verify that your AdminDir is correct for your admin folder name.
    Example: https://www.yoursite.com/youradmin/qbpconnect.aspx
    

NOTE: The folder name value in AdminDir will be CASE SenSeTive so be sure to create the Redirect URI exactly as your AdminDir value is set. It might be best to make it all lower case first in your setting, for simplicity.

NOTE: If your site is using more than one URL version such as www.yoursite.com and yoursite.com (no www), then we suggest setting up your site configuration to enforce using www (or not if you prefer). If you wish to retain more than one version, you will need to create a Redirect URI for each of those versions.

Example: AdminDir value: MyAdmin , and both www and non-www are used, then these would both need entered:
https://www.yoursite.com/MyAdmin/qbpconnect.aspx
https://yoursite.com/MyAdmin/qbpconnect.aspx


20. In another new tab in the same browser session (important!), login to your EXISTING QBMS merchant account.
    https://merchantcenter.intuit.com/msc/portal/init?custmode=msclogin
    


21. Open yet another browser tab to your site admin (if you don't already), go to Configuration - Site Setup Wizard, select the QuickBooks Payments gateway, and open the Configure link for QuickBooks Payments.
    


22. From your app Keys & OAuth page which should still be in an open tab, Copy/Paste the proper Client ID and Client Secret values into the fields on the QuickBooks configuration in your admin Site Setup Wizard page.
    


23. Click the blue "Connect" button on the configuration wizard.
    


24. If all is setup correctly, you should get a QuickBooks page with connection information for your app and company. You may be asked to make selections such as company. Once you are satisfied that the correct connection is being made (your new app and your company), click the green "Connect" button.
    

NOTE: If you are a new user to QuickBooks Payments, you should be asked to sign up and create a Merchant Account. Once that is completed, you might have to return to step 21 and Connect again.


25. Review the resulting message in the Site Setup Wizard (should say that the connection was successful), and save any settings that may still be required there such as using live transaction, SSL yes, Credit Card method, Quickbooks Payments.
    


26. Refresh Store in the admin and you should be all set to test live transactions. All other browser tabs and accounts can now be closed out.