Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
ACH Transactions

Get all ACH transactions for a company

Fetches all ACH transactions for a company.

scope: ach_transactions:read

get/v1/companies/{company_uuid}/ach_transactions

Path parameters

company_uuidstring required

The UUID of the company

Query parameters

contractor_payment_uuidstring

The UUID of the contractor payment

payroll_uuidstring

The UUID of the payroll

transaction_typestring

Used to filter the ACH transactions to only include those with a specific transaction type, such as "Credit employee pay".

payment_directionstring

Used to filter the ACH transactions to only include those with a specific payment direction, either "credit" or "debit".

pageinteger

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

perinteger

Number of objects per page. For majority of endpoints will default to 25

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Example response

uuidstring required

Unique identifier of an ACH transaction

company_uuidstring

Unique identifier of the company to which the ACH transaction belongs

payment_event_type'Payroll' | 'ContractorPayment'

The type of payment event associated with the ACH transaction

payment_event_uuidstring

Unique identifier for the payment event associated with the ACH transaction

recipient_type'Employee' | 'Contractor' nullable

The type of recipient associated with the ACH transaction

recipient_uuidstring

Unique identifier for the recipient associated with the ACH transaction

error_codestring nullable

The error code associated with the ACH transaction, if any. If there is no error on the ACH transaction, this field will be nil. See this article for a complete list of ACH return codes.

transaction_typestring

The type of transaction associated with the ACH transaction

payment_status'unsubmitted' | 'submitted' | 'successful' | 'failed'

The status of the ACH transaction

payment_direction'credit' | 'debit'

The direction of the payment

payment_event_check_datestring

The date of the payment event check associated with the ACH transaction

payment_datestring

The date of the payment associated with the ACH transaction

amountstring

The amount of money moved by the ACH transaction. This amount is always non-negative.

descriptionstring

The description of the ACH transaction. Can be used to identify the ACH transaction on the recipient's bank statement.