List ACH deposits

Browse API reference

GET/ach-depositsgetAchDeposits

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.

Parameters

Name	In	Type	Description
`before`	query	`string`	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.
`after`	query	`string`	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.
`limit`	query	`integer`	Limit the maximum number of results that we return for each page.
`date`Required	query	`string`	Filter results by the date that the merchant received the ACH deposit.
`merchantId`	query	`string`	Filter results by the unique identifier that the processor assigned to the merchant.

Responses

Successful request. Returns a paginated list of ACH deposits.

200 OK · application/json

{
  "count": 0,
  "data": [],
  "hasMore": false,
  "limit": 10,
  "links": []
}

Response schema · 30 of 33 fields

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.
limitinteger
Maximum number of results that we return for each page.
linksobject[]
Reference links to navigate to the previous page of results or to the next page of results.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
dataobject[]required
Array of ACH deposit objects.
- achAdjustmentintegerint64
  Amount of adjustments that we made to the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.
- achDatestringdate
  Date that we sent the ACH deposit. The format of this value is YYYY-MM-DD.
- achDepositIdinteger
  Unique identifier that we assigned to the ACH deposit.
- associationDatestringdate
  Date that we sent the transactions to the card brands for clearing. The format of this value is YYYY-MM-DD.
- dailyFeesintegerint64
  Amount of fees that were applied to the transactions in the ACH deposit. We return the value in the currency's lowest denomination, for example cents.
- heldSalesintegerint64
  Amount of funds that we held if the merchant was in full suspense. We return the value in the currency's lowest denomination, for example, cents.
- holdbackintegerint64
  Amount of funds that we held as reserve from the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.
- linksobject[]
  - hrefstringrequired
    URL of the target resource.
  - methodstringrequired
    HTTP method that you need to use with the target resource.
  - relstringrequired
    Indicates the relationship between the current resource and the target resource.
- merchantobject
  Object that contains information about the merchant.
  - doingBusinessAsstring
    Trading name of the business.
  - linkobject
    Object that contains HATEOAS links for the resource.+3 more fields at deeper levels — see the full spec
  - merchantIdstring
    Unique identifier that the processor assigned to the merchant.
  - processingAccountIdinteger
    Unique identifier that we assigned to the processing account.
- netAmountintegerint64
  Total amount that we paid the merchant after fees and adjustments. We return the value in the currency's lowest denomination, for example, cents.
- paymentDatestringdate
  Date that the merchant received the ACH deposit. The format of this value is YYYY-MM-DD.
- reserveReleaseintegerint64
  Amount of funds that we released from holdback. We return the value in the currency's lowest denomination, for example, cents.
- returnsintegerint64
  Amount of returns in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.
- salesintegerint64
  Amount of sales in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.
- transactionsinteger
  Number of transactions in the ACH deposit.

Validation error

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid value",
      "message": "Expected integer, got abc",
      "parameter": "before"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

review-settlement-reporting