v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Account

Get ACH Transfers

This endpoint allows the retrieval of a list of transfers for an account.

Note: The maximum number of transfers in a list is 180 per request.

If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. Filtering ACH Transfers ACH transfers can be filtered based on the following ACH Transfer Statuses, so specific ACH transfers can be viewed by the Partner. If GET /achTransfers is called and the status provided is one or more of the valid ACH Transfer Statuses (listed above), then the response will contain the ACH transfers within the selected (or defaulted) date range that have an ACH Transfer Status that matches one of the statuses that was provided in the call.

get/programs/{programCode}/accounts/{accountIdentifier}/ACHTransfers

Path parameters

programCodestring required

Partner program code for the account.

accountIdentifierstring required

Unique account identifier (UID or GUID).

Query parameters

startDatestring

Start date for filtering transfers (yyyy-MM-dd).

endDatestring

End date for filtering transfers (yyyy-MM-dd).

statusstring

Comma-separated list of ACH transfer statuses (see ACHTransferStatus enum).

Headers

X-GD-RequestIdstring required

Unique request tracking identifier (X-GD-RequestId header).

Response

OK

totalRecordCountinteger

The total number of ACH transfer records matching the request criteria.