---
title: "View deposit summary"
method: GET
path: "/ach/v3"
tags: ["Deposits"]
---

# View deposit summary

`GET /ach/v3`

Returns a summary of all deposits with the given range for the specified merchant ID or IDs, or for all merchant accounts associated with the API user.

You send the request with zero of more of the query parameters to limit the results as in the following example:

  <code>/ach/v3?limit=25&offest=0&startDate=2024-02-01&endDate=2024-02-08&merchantids=000999</code>

See the [Filtering using query parameters](https://docs.nexiopay.com/docs/filtering-using-query-parameters) topic in Guides for a full tutorial. Note that if you do not include a parameter for this endpoint, the system uses the default value for the request.

For the response, the amounts presented may be different than what was authorized, as the funds may not have settled yet. Amounts being processed may differ temporarily from batch totals if they experience a temporary risk hold; common reasons include large single transactions, unusual activity, or unexpected volume increases. Check the batch details in a few days after it's finalized.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).


<div style="display:none;">

## Request parameters
- limit
- offset
- startDate
- endDate
- merchantIds

## Response parameters
- offset
- limit
- rows (array)
- rows.id
- rows.merchantId
- rows.date
- rows.dda
- rows.amount
- rows.currencyId
- rows.createdAt
- rows.updatedAt
- rows.processor
- rows.processor.id
- rows.processor.originalId
- rows.processor.processorType
- rows.details (array)
- rows.details.achDetailId
- rows.details.type
- rows.details.thirdPartyFundedAmount
- rows.details.amount
- rows.details.currencyId
- rows.details.achSummaryId
- rows.details.processor
- rows.details.processor.id
- rows.details.processor.originalId
- rows.details.processor.processorType
- rows.details.processor.batchRef
- rows.details.processor.achDetailId
- hasMore

</div>

## Query parameters

- `limit` integer
- `offset` integer
- `startDate` string
- `endDate` string
- `merchantIds` string

## Response `200`

Success

- object
  - `offset` integer — The number of rows by which the data is offset
  - `limit` integer — The limit on the number of rows
  - `rows` object[] — An array of deposit summary objects
    - `id` integer — A deposit summary ID
    - `merchantId` string — The merchant ID
    - `date` string, date
    - `dda` string — The last four digits of the account number to which the ACH was deposited
    - `amount` number
    - `currencyId` CurrencyId — unresolved $ref
    - `createdAt` string, date-time — The date and time at which the deposit summary was created
    - `updatedAt` string, date-time — The date and time at which the deposit summary was last updated
    - `processor` object — Processor-specific information
      - `id` integer
      - `originalId` integer
      - `processorType` integer
    - `details` object[] — The details corresponding to this deposit
      - `achDetailId` string — The deposit detail ID.
      - `type` integer — The type for the deposit detail. For information about what the value means, see [ACH detail type (type)](https://docs.nexiopay.com/docs/constant-ach-transaction-values#ach-detail-type-type) in the "Constant ACH transaction values" topic in Guides.
      - `thirdPartyFundedAmount` number
      - `amount` number — The deposit detail amount.
      - `currencyId` string
      - `achSummaryId` integer
      - `processor` object — Processor-specific information. <b>Details will vary by processor. Do NOT code to any information included in this object</b>.
        - `id` integer
        - `originalId` integer — The original ID from the process.
        - `processorType` integer — The Nexio-assigned processor type.
        - `batchRef` string — The processor's batch reference number.
        - `achDetailId` string — The deposit detail ID.
  - `hasMore` boolean — Will be `true` if there are more records not included in the current response

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)