SchemaReportingSettlement

Retrieve ACH deposit

View as MarkdownOpen in Claude
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](https://docs.payroc.com/api/schema/reporting/settlement/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.

Authentication

AuthorizationBearer

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

Path parameters

achDepositIdintegerRequired
Unique identifier of the ACH deposit.

Response

Successful request. Returns the requested ACH deposit.
achDepositIdinteger
Unique identifier that we assigned to the ACH deposit.
associationDatedate

Date that we sent the transactions to the card brands for clearing. The format of this value is YYYY-MM-DD.

achDatedate

Date that we sent the ACH deposit. The format of this value is YYYY-MM-DD.

paymentDatedate

Date that the merchant received the ACH deposit. The format of this value is YYYY-MM-DD.

transactionsinteger
Number of transactions in the ACH deposit.
saleslong
Amount of sales in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.
returnslong
Amount of returns in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.
dailyFeeslong
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.
heldSaleslong
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.
achAdjustmentlong
Amount of adjustments that we made to the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.
holdbacklong
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.
reserveReleaselong
Amount of funds that we released from holdback. We return the value in the currency's lowest denomination, for example, cents.
netAmountlong
Total amount that we paid the merchant after fees and adjustments. We return the value in the currency's lowest denomination, for example, cents.
merchantobject
Object that contains information about the merchant.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
500
Internal Server Error