> ## Documentation Index > Fetch the complete documentation index at: https://docs.mx.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml openapi/platform-api/v20250224.yaml GET /ach_returns openapi: 3.0.0 info: contact: name: MX Platform API url: https://www.mx.com/products/platform-api description: > The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. ## What's Changed? Several endpoints, headers, and fields changed in `v20250224`. For more on breaking changes, refer to our [versioning](/api-reference/platform-api/overview/versioning#v20250224) and [migration](/api-reference/platform-api/overview/migration) guides. ## Version Header Versions are set in the `Accept-Version` header of API requests. Version numbers correspond with the date associated with that version. The example below uses the version `v20250224`. ``` -H 'Accept: application/json' -H 'Accept-Version: v20250224' ``` --- title: MX Platform API version: '20250224' servers: - url: https://int-api.mx.com - url: https://api.mx.com security: - basicAuth: [] tags: - name: authorization - name: accounts description: > The Accounts endpoints represent a user's checking, savings, mortgage, 401(k), or other types of accounts held by a financial institution. An account belongs to a `member`, which represents the user's overall relationship with a particular financial institution. A checking account may be just one part of a larger relationship that could also include a car loan and a savings account. Accounts—and the transactions associated with them—are updated every 24 hours, unless the associated `user` is disabled. You can also create manual accounts. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed. All manual accounts are automatically created under the Manual Institution member. - name: ach return description: > The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. Using our Platform API, you can securely submit ACH Returns to reduce your ACH return rates and automate your ACH return process. You can query the status and outcomes of your submitted ACH returns to track progress and access resolution details. - name: budgets description: > Use these endpoints to create and manage budgets for your end users. You can create a budget for a specific category or autogenerate a budget for several categories based on existing transactions. Each budget has a `category_guid`, relating to one of the [categories](docs.mx.com/api-reference/platform-api/reference/categories#default-categories-and-subcategories). - name: categories description: > A `transaction` can have its `category` set to one of MX’s default categories or a custom category for a specific `user`. See [Default Categories and Subcategories](docs.mx.com/api-reference/platform-api/reference/categories#default-categories-and-subcategories) for a complete list. - name: deprecated - name: goals description: > Use these endpoints to create and manage goals for a `user`. You can also reposition goals to adjust their priority levels. Every goal has a track type and a meta type. The [track type](docs.mx.com/api-reference/platform-api/reference/goals/#goal-track-type) is the overall classification of the goal (debt, savings, retirement, or emergency fund) while the [meta type](docs.mx.com/api-reference/platform-api/reference/goals/#goal-meta-type) is the specific classification (like college, house, vacation, and so on). - name: insights description: > Use these endpoints to build customizable user experiences in UIs powered by our Financial Insights data. With Financial Insights, your users will receive personalized insights based on their transaction history. Want to learn more about the product? See [Financial Insights](docs.mx.com/products/experience/insights). Looking for a guide to use these endpoints? See [Build Your Own Insights UI](docs.mx.com/products/experience/insights/integration-guides/insights-api-guide). - name: institutions description: > Institutions represent a financial institution. A single real-world financial institution may have several `institution` objects on the MX platform. For example, the mortgage division of a financial institution might use a separate system than its everyday banking division, which is different from its credit card division. For more info, see [Institutions Overview](docs.mx.com/api-reference/reference/institutions). - name: investment holdings description: > Investment Data Enhancement lets you connect to an end user's financial institution and retrieve cleansed and enhanced investment data. By combining investment data with retail banking information, you get comprehensive insights into customer financial behaviors, risk tolerance, and investment strategies. You can [read a user's holding](docs.mx.com/api-reference/platform-api/reference/read-holding), [list all their holdings](docs.mx.com/api-reference/platform-api/reference/list-holdings), or list their holdings by [account](docs.mx.com/api-reference/platform-api/reference/list-holdings-by-account) or [member](docs.mx.com/api-reference/platform-api/reference/list-holdings-by-member). You can also [deactivate a user](docs.mx.com/api-reference/platform-api/reference/deactivate-user) from the Investment Data Enhancement. This is non-billable. - name: managed data - name: members description: > Members represent the connection between an end user and a financial institution. This institution may represent your institution or another one from which MX is aggregating data. For more info, see [Members Overview](docs.mx.com/api-reference/reference/members). - name: merchants description: > Merchants are representations of a transaction’s origin. For example, if you buy a coffee at Starbucks, the transaction merchant will be `Starbucks`. Use the `merchant_guid` and a `merchant_location_guidon` any `transaction` object to access Merchant endpoints for details like the merchant’s name, logo URL, website, street address, and more. - name: microdeposits description: > Microdeposits is an additional verification method that allows you to verify account details and navigate the process of using microdeposits and the automated clearing house (ACH) system. Make two, small ACH deposits into a consumer's account using the provided account and routing number. You can then require that the end user confirm the exact amount of each deposit to verify that they own the account and meet NACHA’s account verification. For more info, including process flows, setting block lists, and more, see [Microdeposits](docs.mx.com/products/connectivity/microdeposits). - name: monthly cash flow profile - name: notifications description: > You can only use notifications endpoints if you’re using the MX mobile application. All notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity. No other channels are supported. The read and list endpoints can return any notification associated with the `user`, including notifications created by MX for other channels besides `PUSH`. - name: processor token - name: rewards - name: spending plan description: > Use the Spending Plan endpoints to create your own version of our [Spending Plan Widget](docs.mx.com/products/experience/pfm/legacy-widget-overviews/spending-plan), which helps end users track their spending throughout the month. To understand key terms and how to best use these endpoints, see [Build Your Own Spending Plan UI](docs.mx.com/products/experience/pfm/integration-guides/build-your-own-spending-plan-ui). - name: statements description: > With Statements, you can retrieve a user's monthly account statements in PDF format. This data can be used for solutions like personal financial management or risk analysis. - name: taggings description: > Tags and taggings are two resources in the MX Platform API that, when used together, give end users more control over organizing their transactions. A tag is a custom label that can be applied to a transaction. After you create a tag, use it for tagging. This means you should actually apply the tag to a particular transaction. Together, they're a powerful tool for personalization, customization, and money management. For a guide on creating a tag and then applying it to a specific transaction with a tagging, see [Custom Tags and Taggings](docs.mx.com/products/experience/pfm/integration-guides/personalization/). - name: tags description: > Tags and taggings are two resources in the MX Platform API that, when used together, give end users more control over organizing their transactions. A tag is a custom label that can be applied to a transaction. After you create a tag, use it for tagging. This means you should actually apply the tag to a particular transaction. Together, they're a powerful tool for personalization, customization, and money management. For a guide on creating a tag and then applying it to a specific transaction with a tagging, see [Custom Tags and Taggings](docs.mx.com/products/experience/pfm/integration-guides/personalization/). - name: transaction rules description: > Transaction Rules allow users to automatically recategorize or rename all similar transactions according to their preferences. This only applies to future transactions. When recategorizing or renaming a transaction, the user will be asked whether they want the new data to apply to the selected transaction or to all future transactions. If they choose to apply it to all future transactions, it will create a transaction rule which will automatically apply the changes going forward. - name: transactions description: > Transactions represent any instance in which money moves into or out of an account. This could be a purchase at a business, a payroll deposit, a transfer from one account to another, an ATM withdrawal, and so on. Transactions are created automatically when a member is successfully aggregated. Each `transaction` belongs to only one `account`. For more info, see [Transactions Overview](docs.mx.com/api-reference/reference/transactions). - name: users description: > Users represent an end user using the Platform API through your web or mobile app. Users are created by MX clients and belong to a specific [client](docs.mx.com/products/connectivity/overview/data-architecture/#clients) on the platform. - name: verifiable credentials description: > MX provides Verifiable Credential endpoints that comply with web5 standards. For more info, see [Verifiable Credentials Overview](docs.mx.com/api-reference/reference/verifiable-credentials). - name: widgets description: > Use the [Request Widget URL](docs.mx.com/api-reference/platform-api/reference/request-widget-url) endpoint to generate a URL that loads one of our widgets. Many request body parameters only work for some widgets. For more info, including widget types, see [Widgets Overview](docs.mx.com/api-reference/reference/widgets). paths: /ach_returns: get: tags: - ach return summary: List ACH Returns description: | Use this endpoint to get all ACH returns. operationId: listACHRetruns parameters: - $ref: '#/components/parameters/institutionGuid' - $ref: '#/components/parameters/returnedAt' - $ref: '#/components/parameters/resolvedStatusAt' - $ref: '#/components/parameters/returnCode' - $ref: '#/components/parameters/returnStatus' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/recordsPerPage' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ACHReturnsResponseBody' description: OK components: parameters: institutionGuid: description: >- The identifier for the institution associated with the ACH return. Defined by MX. in: query name: institution_guid required: false schema: type: string returnedAt: description: >- The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp. example: '2025-02-13T18:09:00+00:00' in: query name: returned_at required: false schema: type: string resolvedStatusAt: description: >- The date and time when the return was resolved by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp example: '2025-02-13T18:09:00+00:00' in: query name: resolved_status_at required: false schema: type: string returnCode: description: >- The associated ACH return code and notice of change code. See [Return Codes](/api-reference/platform-api/reference/ach-return-fields/#return-codes) for a complete list. in: query name: return_code required: false schema: type: string returnStatus: description: >- The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields/#return-status) for a complete list. example: SUBMITTED in: query name: return_status required: false schema: type: string page: description: Results are paginated. Specify current page. example: 1 in: query name: page schema: type: integer recordsPerPage: description: >- 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. example: 10 in: query name: records_per_page schema: type: integer schemas: ACHReturnsResponseBody: properties: ach_returns: items: $ref: '#/components/schemas/ACHResponse' type: array pagination: $ref: '#/components/schemas/PaginationResponse' type: object ACHResponse: properties: account_guid: description: The unique identifier for an account. Defined by MX. example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 nullable: false type: string account_number_last_four: description: >- The last 4 digits of the account number used for the transaction by the Originating Depository Financial Institution (ODFI). example: '1234' nullable: true type: string account_type: description: The type of account. Some account types may include subtypes. example: CHECKING nullable: true type: string enum: - ANY - CASH - CHECKING - CHECKING_LINE_OF_CREDIT - CREDIT_CARD - LOAN - LINE_OF_CREDIT - SAVINGS - INVESTMENT - MORTGAGE - INSURANCE - PREPAID - PROPERTY ach_initiated_at: description: >- The date and time when the transaction was initiated by the Originating Depository Financial Institution (ODFI) in ISO 8601 format without timestamp. example: '2025-02-13T18:08:00+00:00' nullable: true type: string client_guid: description: >- The unique identifier for the client associated with the insight. Defined by MX. example: CLT-abcd-1234 nullable: false type: string corrected_account_number: description: >- The account number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`. example: null nullable: true type: string corrected_routing_number: description: >- The routing number correction reported by the RDFI. Populated only if the `resolution_code` is `NOTICE_OF_CHANGE`. Must be a valid 9-digit routing number format. example: null nullable: true type: string created_at: description: >- The date and time the ACH return was created, represented in ISO 8601 format with a timestamp. example: '2025-02-13T18:08:00+00:00' nullable: false type: string guid: description: The unique identifier for the ACH return record. Defined by MX. example: ACH-d74cb14f-fd0a-449f-991b-e0362a63d9c6 nullable: false type: string id: description: >- Client-defined identifier for this specific return submission. Allows you to track and reference your requests. example: client_ach_return_id_1234 nullable: false type: string institution_guid: description: The unique identifier for an institution. Defined by MX. example: INS-34r4f44b-cfge-0f6e-3484-21f47e45tfv7 nullable: false type: string investigation_notes: description: >- Notes added by Product Support during investigation of the ACH return. example: null nullable: true type: string member_guid: description: The unique identifier for the member. Defined by MX. example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b nullable: false type: string processing_errors: description: Any errors that occurred during processing. example: null nullable: true type: string resolution_code: description: >- A short, machine-readable code that categorizes the type of resolution or reason for the status. See [Resolution Codes](/api-reference/platform-api/reference/ach-return-fields#resolution-codes) for a complete list. example: null nullable: true type: string resolution_detail: description: >- A more detailed, human-readable message providing context and next steps related to the `return_status` and `resolution_code`. example: null nullable: true type: string resolved_status_at: description: Date and time when the return was marked as resolved. example: null nullable: true type: string return_code: description: >- The associated ACH return codes and notice of change codes (for example, R02, R03, R04, R05, R20, NOC). See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list example: R01 nullable: false type: string return_notes: description: Notes that you set to inform MX on internal ACH processing. example: null nullable: true type: string return_account_number: description: Incorrect account number used in the ACH transaction. example: null nullable: true type: string return_routing_number: description: Incorrect routing number used in the ACH transaction. example: null nullable: true type: string return_status: description: >- The current processing status of the ACH return. See [Return Status](/api-reference/platform-api/reference/ach-return-fields#return-status) for a complete list of statuses. example: SUBMITTED nullable: true type: string returned_at: description: >- The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp. example: '2025-02-13T18:09:00+00:00' nullable: true type: string sec_code: description: >- The three-letter SEC code (Standard Entry Class Code) describing how a payment was authorized (for example, `WEB`). See [SEC Codes](/api-reference/platform-api/reference/ach-return-fields#sec-codes) for a complete list. example: PPD nullable: true type: string started_processing_at: description: Date and time when MX started processing the return. example: null nullable: true type: string submitted_at: description: Date and time when the record was submitted through the API. example: null nullable: true type: string transaction_amount: description: The amount of the transaction. example: 225.84 format: double nullable: true type: number updated_at: description: Date and time when the ACH return record was last updated. example: 'null' nullable: false type: string user_guid: description: The unique identifier for the user. Defined by MX. example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 nullable: false type: string type: object PaginationResponse: properties: current_page: description: The page delivered by the current response. example: 1 type: integer per_page: description: The number of records delivered with each page. example: 25 type: integer total_entries: description: The total number of records available. example: 1 type: integer total_pages: description: The total number of pages available. example: 1 type: integer type: object securitySchemes: basicAuth: scheme: basic type: http description: > The MX Platform API requires basic access authentication using your `client_id` and `api_key`. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access. Here's an example using curl to access `v20250224`. Replace `https://int-api.mx.com/endpoint` with the actual API endpoint you wish to access and your Base64 encoded `client_id` and `api_key`. ``` curl -L -X POST `https://int-api.mx.com/endpoint' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Accept-Version: v20250224' -H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}' ``` ````