Settlement

List ACH deposits

Changed on

Use this method to return a paginated 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 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.
get/ach-deposits

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/ach-deposits
  • Auth
    HTTP bearer

Query parameters

beforestring

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.

afterstring

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.

limitinteger

Limit the maximum number of results that we return for each page.

datestring date required

Filter results by the date that the merchant received the ACH deposit.

merchantIdstring

Filter results by the unique identifier that the processor assigned to the merchant.

Response

Successful request. Returns a paginated list of ACH deposits.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

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

hasMoreboolean

Indicates whether there is another page of results available.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id listAchDeposits removed and replaced with settlement_listAchDeposits