Connectors / Service / QuickBooks Payments

Accounting service (updated: 1633687987435)

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.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

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

All Operations

Latest version:

1.0

Retrieve a charge refund

Retrieve the details of an existing charge refund by ID.

Create bank account from token

Create a new bank account for customer from a payment token.

Void a charge transaction

Processes a void of a charge request that times out. It cannot be used to void a charge that has already been settled.

Capture charge funds

Capture a specific charge by ID.

Create bank account

Create a new bank account for customer with bank account details.

Create charge

Create a new charge from a credit card registered on file.

List customer credit cards

Retrieve a list of credit cards associated with a customer.

Create echeck debit

Create a new ECheck debit from a bank account token.

Create payment token

Create a new payment token associated with a bank account.

Delete bank account

Retrieve a specific bank account associated with a customer.

Get bank account

Retrieve a specific bank account associated with a customer.

List customer bank accounts

Retrieve a list of bank accounts associated with a customer.

Refund a charge

Fully or partially refund an existing charge.

Retrieve a charge

Retrieve the details of an credit card transaction that has been previously created.

Retrieve an echeck

Retrieve the details of an echeck transaction that has been previously created.

Retrieve an echeck refund

Retrieve the details of an ECheck refund transaction that has been previously created.

Void or refund an echeck

Full or partial refund an existing ECheck transaction. Refund requests made on the same day as the associated debit request may result in the transaction being voided. Refunds cannot be issued unless the original debit has succeeded (this process typically takes approximately three business days).