Retrieve ACH deposit

Browse API reference

GET/ach-deposits/{achDepositId}getAchDeposit

Use this method to retrieve information about an ACH deposit that we paid to a merchant.

Note: To retrieve an ACH deposit, you need its achDepositId. If you don't have the achDepositId, use our List ACH Deposits method to search for the ACH deposit.

Our gateway returns the following information about the ACH deposit:

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
`achDepositId`Required	path	`integer`	Unique identifier of the ACH deposit.

Responses

Successful request. Returns the requested ACH deposit.

200 OK · application/json

{
  "achAdjustment": 1000,
  "achDate": "2024-07-02",
  "achDepositId": 99,
  "associationDate": "2024-07-02",
  "dailyFees": 1000,
  "heldSales": 1000,
  "holdback": 1000,
  "links": [
    {
      "href": "https://api.payroc.com/v1/ach-deposit-fees?achDepositId=99&merchantId=4525644354",
      "method": "get",
      "rel": "achDepositFees"
    }
  ],
  "merchant": {
    "doingBusinessAs": "Pizza Doe",
    "link": {
      "href": "https://api.payroc.com/v1/processing-accounts/38765",
      "method": "get",
      "rel": "processingAccount"
    },
    "merchantId": "4525644354",
    "processingAccountId": 38765
  },
  "netAmount": 36500,
  "paymentDate": "2024-07-02",
  "reserveRelease": 500,
  "returns": 10000,
  "sales": 50000,
  "transactions": 10
}

Response schema · 25 fields

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.
  - 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.
- 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": "achDepositId"
    }
  ],
  "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

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
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