SchemaReportingSettlement

List ACH deposits

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of ACH deposits that we paid to your merchants. **Note:** If you want to view the details of a specific ACH deposit and you have its achDepositId, use our [Retrieve ACH Deposit](https://docs.payroc.com/api/schema/reporting/settlement/retrieve-ach-deposit) method. Use query parameters to filter the list of results that we return, for example, to search for ACH deposits that we paid to a specific merchant. > **Important:** You must provide a value for the date query parameter. Our gateway returns the following information about each ACH deposit in the list: - Merchant that we sent the ACH deposit to. - Total amount that we paid the merchant. - Breakdown of sales, returns, and fees.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.
datedateRequired
Filter results by the date that the merchant received the ACH deposit.
merchantIdstringOptional
Filter results by the unique identifier that the processor assigned to the merchant.

Response

Successful request. Returns a paginated list of ACH deposits.
datalist of objects
Array of ACH deposit objects.
countdouble or null

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean or null
Indicates whether there is another page of results available.
limitdouble or null
Maximum number of results that we return for each page.

Errors