Open Navigation

Quickbooks Payments

Accounting software.

Overview

QuickBooks is an accounting software package developed and marketed by Intuit.

Authentication

When using the Quickbooks connector, the first thing you will have to do is click on 'New Authentication' in the step editor:

quickbooks-auth

You will need to select either the Development or Production environment, then click Next and allow Tray to connect to your company.

Basic Operations List

There are a lot of operations available for this connector. Please see the full operations reference at the end of this guide.

In this example we are going to be using the following operations:

  • Create payment token
  • Create echeck debit
  • Retrieve an echeck
  • Void or refund an echeck

Example

In the following example we create a workflow that creates an echeck, retrieves the echeck and voids the echeck.

To begin with, create a workflow with a Manual Trigger, then add a step from the Quickbooks Payments connector with the operation set to Create payment token. Enter the relevant bank account details to be used to transact the charge. In the following example we are using dummy data in the development environment for Quickbooks Payments (as selected in the authentication):

quickbooks-payments-token-dummy-input

We can run our workflow and view our payment token in the output panel of the workflow, as shown in this example:

quickbooks-payments-token-output

Next, add a step from the Quickbooks Payments connector and specify the operation as Create echeck debit. We then want to set the Token field as the value returned by the Create payment token operation in the previous step. We can do this by using a JsonPath as pictured in this example:

quickbooks-payments-jsonpath-token

Enter the remaining values for the operation, such as the Amount that the echeck debit will be for. We can then run the operation to create the ECheck as in the example:

quickbooks-payments-create-echeck-output

Next, we want to add another step from the Quickbooks Payments connector and specify the operation as Retrieve an echeck. We then want to set the ECheck ID as a JsonPath value from the Create echeck debit operation in the previous step, as in the example:

quickbooks-payments-jsonpath-retrieve-echeck

We can then run the workflow to retrieve information about the echeck, as in the example:

quickbooks-payments-retrieve-echeck-output

Note: When creating an echeck debit, the Status of the echeck will remain Pending until the echeck has cleared. This can take 24-48 hours usually, but sometimes can be longer.

Finally, we want to add the final step in our workflow from the Quickbooks Payments connector. Add the new step and specify the operation as Void or refund an echeck. Again we want to JsonPath the ECheck ID that we want to be voided, as in the following example:

quickbooks-payments-refund-echeck-jsonpath

After specifying the amount that we would like be refunded, we can then run the workflow and view the output panel to ensure that the echeck has been successfully voided, as displayed in this example:

quickbooks-payments-refund-echeck-output

Was this article helpful?
Yes
No