return_create_request

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
returnable_id	string	The ID of the object being returned or `null`.
code	string	The return code. For ACH returns, this is the required ACH return code.
reason	string	An optional description of the reason for the return. This is for internal usage and will not be transmitted to the bank.”
date_of_death	string	If the return code is `R14` or `R15` this is the date the deceased counterparty passed away.
additional_information	string	Some returns may include additional information from the bank. In these cases, this string will be present.
data	object	The raw data from the return file that we get from the bank.
corrections	object	Only relevant for ACH NOC returns. This is an object containing all of the new and corrected information provided by the bank that was previously incorrect on the original outgoing payment.
reconciliation_status	string	One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
returnable_type	string	The type of object being returned. Currently, this may only be incoming_payment_detail.
ledger_transaction	object	Specifies a ledger transaction object that will be created with the return. If the ledger transaction cannot be created, then the return creation will fail. The resulting ledger transaction will mirro

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/return_create_request",
  "title": "return_create_request",
  "type": "object",
  "properties": {
    "returnable_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the object being returned or `null`.",
      "nullable": true
    },
    "code": {
      "type": "string",
      "enum": [
        "901",
        "902",
        "903",
        "904",
        "905",
        "907",
        "908",
        "909",
        "910",
        "911",
        "912",
        "914",
        "C01",
        "C02",
        "C03",
        "C05",
        "C06",
        "C07",
        "C08",
        "C09",
        "C13",
        "C14",
        "R01",
        "R02",
        "R03",
        "R04",
        "R05",
        "R06",
        "R07",
        "R08",
        "R09",
        "R10",
        "R11",
        "R12",
        "R13",
        "R14",
        "R15",
        "R16",
        "R17",
        "R18",
        "R19",
        "R20",
        "R21",
        "R22",
        "R23",
        "R24",
        "R25",
        "R26",
        "R27",
        "R28",
        "R29",
        "R30",
        "R31",
        "R32",
        "R33",
        "R34",
        "R35",
        "R36",
        "R37",
        "R38",
        "R39",
        "R40",
        "R41",
        "R42",
        "R43",
        "R44",
        "R45",
        "R46",
        "R47",
        "R50",
        "R51",
        "R52",
        "R53",
        "R61",
        "R62",
        "R67",
        "R68",
        "R69",
        "R70",
        "R71",
        "R72",
        "R73",
        "R74",
        "R75",
        "R76",
        "R77",
        "R80",
        "R81",
        "R82",
        "R83",
        "R84",
        "R85",
        "currencycloud"
      ],
      "nullable": true,
      "description": "The return code. For ACH returns, this is the required ACH return code."
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "description": "An optional description of the reason for the return. This is for internal usage and will not be transmitted to the bank.\u201d"
    },
    "date_of_death": {
      "type": "string",
      "nullable": true,
      "format": "date",
      "description": "If the return code is `R14` or `R15` this is the date the deceased counterparty passed away."
    },
    "additional_information": {
      "type": "string",
      "nullable": true,
      "description": "Some returns may include additional information from the bank. In these cases, this string will be present."
    },
    "data": {
      "type": "object",
      "nullable": true,
      "description": "The raw data from the return file that we get from the bank."
    },
    "corrections": {
      "type": "object",
      "nullable": true,
      "properties": {
        "account_number": {
          "type": "string",
          "nullable": true,
          "description": "The updated account number that should replace the one originally used on the outgoing payment."
        },
        "company_id": {
          "type": "string",
          "nullable": true,
          "description": "The updated company ID that should replace the one originally used on the outgoing payment."
        },
        "company_name": {
          "type": "string",
          "nullable": true,
          "description": "The updated company name that should replace the one originally used on the outgoing payment."
        },
        "individual_identification_number": {
          "type": "string",
          "nullable": true,
          "description": "The updated individual identification number that should replace the one originally used on the outgoing payment."
        },
        "routing_number": {
          "type": "string",
          "nullable": true,
          "description": "The updated routing number that should replace the one originally used on the outgoing payment."
        },
        "transaction_code": {
          "type": "string",
          "nullable": true,
          "description": "The updated account type code that should replace the one originally used on the outgoing payment."
        }
      },
      "description": "Only relevant for ACH NOC returns. This is an object containing all of the new and corrected information provided by the bank that was previously incorrect on the original outgoing payment."
    },
    "reconciliation_status": {
      "type": "string",
      "enum": [
        "unreconciled",
        "tentatively_reconciled",
        "reconciled"
      ],
      "description": "One of `unreconciled`, `tentatively_reconciled` or `reconciled`."
    },
    "returnable_type": {
      "type": "string",
      "enum": [
        "incoming_payment_detail"
      ],
      "description": "The type of object being returned. Currently, this may only be incoming_payment_detail."
    },
    "ledger_transaction": {
      "$ref": "#/components/schemas/ledger_transaction_create_request",
      "description": "Specifies a ledger transaction object that will be created with the return. If the ledger transaction cannot be created, then the return creation will fail. The resulting ledger transaction will mirror the status of the return."
    }
  },
  "required": [
    "returnable_id",
    "returnable_type"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/modern-treasury-return-create-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.