Settlement

Retrieve ACH deposit

Changed on

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.
get/ach-deposits/{achDepositId}

Request

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

Path parameters

achDepositIdinteger required

Unique identifier of the ACH deposit.

Response

Successful request. Returns the requested ACH deposit.

achDepositIdinteger

Unique identifier that we assigned to the ACH deposit.

associationDatestring date

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

achDatestring date

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

paymentDatestring date

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.

salesinteger

Amount of sales in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.

returnsinteger

Amount of returns in the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.

dailyFeesinteger

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.

heldSalesinteger

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.

achAdjustmentinteger

Amount of adjustments that we made to the ACH deposit. We return the value in the currency's lowest denomination, for example, cents.

holdbackinteger

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.

reserveReleaseinteger

Amount of funds that we released from holdback. We return the value in the currency's lowest denomination, for example, cents.

netAmountinteger

Total amount that we paid the merchant after fees and adjustments. We return the value in the currency's lowest denomination, for example, cents.

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 retrieveAchDeposit removed and replaced with settlement_retrieveAchDeposit