QuickBooks QBMS v0 Payment API Migration Guide
What is happening?
The Intuit Developer Group has made the decision to deprecate the Legacy QBMS Payments API. The API has served Intuit, developers, and merchants for over ten years. Intuit is focused on continually providing our developers with the features and functionality needed to support our mutual customers which lead to this decision. The deprecation date is set for November 12, 2019.
Developers will now only have a single Payments API option for adding Intuit payments to your applications. The Payments API is REST-like and uses OAuth 2.0 for authentication.
When is it happening?
- November 12, 2019: the Legacy QBMS Payments API will be disabled
Can I still use Intuit Payments in my application?
Yes, you can. Intuit continues to support and enhance the Payments API, with documentation found here.
What do you need to do?
- If you have existing customers or QuickBooks merchants using your service or application that rely on the Legacy QBMS Payments API then you will need to migrate to the latest Payments API.
- If you are not planning to migrate, or need help with your migration contact us, we will try to assist.
Follow this guide for migration:
Step 1: Review the feature mapping from Legacy to Latest Payment API below.
|Legacy||Latest Payment API||Notes|
|CustomerCheck*||eChecks||In addition to being able to debit and refund check transactions, you can now also query for the status of the transaction.|
|CustomerCreditCard*||Charges||An explicit voice authorization or void is no longer available. To authorize a transaction, set the capture flag to false and later call the capture endpoint. To void or refund a transaction, call the refund endpoint, and the transaction will be marked cancelled or refunded depending on if the transaction is eligible to be voided.|
|CustomerDebitCard*||Charges||There is no longer an explicit debit card API, which required specific hardware.|
|Customer Query||Not Available|
|Merchant Batch Close||Not Available|
|Customer Scheduled Billing||Not Available|
|Tokens||A one-time use token with limited lifespan that can be used for processing and help avoid PCI compliance related to handling card information on your app server.|
|Wallet||Cards||You can create a reference to a payment method either directly or via a token for future use in the charges or echecks APIs.|
Step 2: Integrate with the new Authentication and Authorization Flow
OAuth 2.0 is used in place of the previous connection ticket model. We provide instructions on creating keys and implementing the necessary workflows to exchange and maintain tokens.
Step 3: Communicate to customers about the migration
In order for your app to process payments on behalf of customers, customers will need to explicitly authorize your app.
Step 4: Customers migrate by authorizing the application to access their Payment service.
How can I test my integration?
I have questions!
Help is available at https://help.developer.intuit.com – we will answer any concerns or questions you may have.
The Intuit Developer Group