{
  "opencollection": "1.0.0",
  "info": {
    "name": "MX Platform accounts ach return API",
    "version": "20111101"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "ach return",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Read ACH Return",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/ach_returns/:ach_return_guid",
            "params": [
              {
                "name": "ach_return_guid",
                "value": "",
                "type": "path",
                "description": "The unique identifier (`guid`) for the ACH return. Defined by MX."
              }
            ]
          },
          "docs": ":::warning\nThe features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.\n:::\n\nUse this endpoint to get an ACH return by its `guid` or `id`.\n"
        },
        {
          "info": {
            "name": "List ACH Returns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/ach_returns",
            "params": [
              {
                "name": "institution_guid",
                "value": "",
                "type": "query",
                "description": "The identifier for the institution associated with the ACH return. Defined by MX."
              },
              {
                "name": "returned_at",
                "value": "2025-02-13T18:09:00+00:00",
                "type": "query",
                "description": "The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp."
              },
              {
                "name": "resolved_status_at",
                "value": "2025-02-13T18:09:00+00:00",
                "type": "query",
                "description": "The date and time when the return was resolved by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp"
              },
              {
                "name": "return_code",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "return_status",
                "value": "SUBMITTED",
                "type": "query",
                "description": "The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields#return-status) for a complete list."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": ":::warning\nThe features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.\n:::\n\nUse this endpoint to get all ACH returns.\n"
        },
        {
          "info": {
            "name": "Create ACH Return",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://int-api.mx.com/ach_returns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": ":::warning\nThe features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.\n:::\n\nUse this endpoint to create an ACH return in our system.\n"
        }
      ]
    }
  ],
  "bundled": true
}