List ACH Returns - MX Documentation

Authorizations

Authorization

string

header

required

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}'

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

ach_returns

object[]

Hide child attributes

ach_returns.account_guid

string

The unique identifier for an account. Defined by MX.

Example:

"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1"

ach_returns.account_number_last_four

string | null

The last 4 digits of the account number used for the transaction by the Originating Depository Financial Institution (ODFI).

Example:

"1234"

ach_returns.account_type

enum<string> | null

The type of account. Some account types may include subtypes.

Available options:

ANY,

CASH,

CHECKING,

CHECKING_LINE_OF_CREDIT,

CREDIT_CARD,

LOAN,

LINE_OF_CREDIT,

SAVINGS,

INVESTMENT,

MORTGAGE,

INSURANCE,

PREPAID,

PROPERTY

Example:

"CHECKING"

ach_returns.ach_initiated_at

string | null

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"

ach_returns.client_guid

string

The unique identifier for the client associated with the insight. Defined by MX.

Example:

"CLT-abcd-1234"

ach_returns.corrected_account_number

string | null

The account number correction reported by the RDFI. Populate only if the resolution_code is NOTICE_OF_CHANGE.

Example:

null

ach_returns.corrected_routing_number

string | null

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

ach_returns.created_at

string

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"

ach_returns.guid

string

The unique identifier for the ACH return record. Defined by MX.

Example:

"ACH-d74cb14f-fd0a-449f-991b-e0362a63d9c6"

ach_returns.id

string

Client-defined identifier for this specific return submission. Allows you to track and reference your requests.

Example:

"client_ach_return_id_1234"

ach_returns.institution_guid

string

The unique identifier for an institution. Defined by MX.

Example:

"INS-34r4f44b-cfge-0f6e-3484-21f47e45tfv7"

ach_returns.investigation_notes

string | null

Notes added by Product Support during investigation of the ACH return.

Example:

null

ach_returns.member_guid

string

The unique identifier for the member. Defined by MX.

Example:

"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

ach_returns.processing_errors

string | null

Any errors that occurred during processing.

Example:

null

ach_returns.resolution_code

string | null

A short, machine-readable code that categorizes the type of resolution or reason for the status. See Resolution Codes for a complete list.

Example:

null

ach_returns.resolution_detail

string | null

A more detailed, human-readable message providing context and next steps related to the return_status and resolution_code.

Example:

null

ach_returns.resolved_status_at

string | null

Date and time when the return was marked as resolved.

Example:

null

ach_returns.return_code

string

The associated ACH return codes and notice of change codes (for example, R02, R03, R04, R05, R20, NOC). See Return Codes for a complete list

Example:

"R01"

ach_returns.return_notes

string | null

Notes that you set to inform MX on internal ACH processing.

Example:

null

ach_returns.return_account_number

string | null

Incorrect account number used in the ACH transaction.

Example:

null

ach_returns.return_routing_number

string | null

Incorrect routing number used in the ACH transaction.

Example:

null

ach_returns.return_status

string | null

The current processing status of the ACH return. See Return Status for a complete list of statuses.

Example:

"SUBMITTED"

ach_returns.returned_at

string | null

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"

ach_returns.sec_code

string | null

The three-letter SEC code (Standard Entry Class Code) describing how a payment was authorized (for example, WEB). See SEC Codes for a complete list.

Example:

"PPD"

ach_returns.started_processing_at

string | null

Date and time when MX started processing the return.

Example:

null

ach_returns.submitted_at

string | null

Date and time when the record was submitted through the API.

Example:

null

ach_returns.transaction_amount

number<double> | null

The amount of the transaction.

Example:

225.84

ach_returns.updated_at

string

Date and time when the ACH return record was last updated.

Example:

null

ach_returns.user_guid

string

The unique identifier for the user. Defined by MX.

Example:

"USR-fa7537f3-48aa-a683-a02a-b18940482f54"

pagination

object

Hide child attributes

pagination.current_page

integer

The page delivered by the current response.

Example:

1

pagination.per_page

integer

The number of records delivered with each page.

Example:

25

pagination.total_entries

integer

The total number of records available.

Example:

1

pagination.total_pages

integer

The total number of pages available.

Example:

1