QuickBooks PaymentsAccounting software.
QuickBooks is an accounting software package developed and marketed by Intuit.
When using the QuickBooks connector, the first thing you will have to do is click on 'New Authentication' in the step editor:
You will need to select either the Development or Production environment, then click Next and allow Tray to connect to your company.
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
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):
We can run our workflow and view our
payment token in the output panel of the workflow, as shown in this example:
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:
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:
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:
We can then run the workflow to retrieve information about the echeck, as in the example:
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:
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: