Skip to main content
GET
List ACH Returns
The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.
Use this endpoint to get all ACH returns.

Authorizations

Authorization
string
header
required

To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request: -H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Query Parameters

institution_guid
string

The identifier for the institution associated with the ACH return. Defined by MX.

returned_at
string

The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.

resolved_status_at
string

The date and time when the return was resolved by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp

return_code
string

The associated ACH return code and notice of change code. See Return Codes for a complete list.

return_status
string

The status of the return. See Return Statuses for a complete list.

page
integer

Results are paginated. Specify current page.

records_per_page
integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

Response

200 - application/json

OK

ach_returns
object[]
pagination
object