Create an ACH Prenotification

v1.0.0

Input

{
  "type": "object",
  "required": [
    "account_number",
    "routing_number"
  ],
  "properties": {
    "account_number": {
      "type": "string",
      "description": "The account number for the destination account."
    },
    "addendum": {
      "type": "string",
      "description": "Additional information that will be sent to the recipient."
    },
    "company_descriptive_date": {
      "type": "string",
      "description": "The description of the date of the transfer."
    },
    "company_discretionary_data": {
      "type": "string",
      "description": "The data you choose to associate with the transfer."
    },
    "company_entry_description": {
      "type": "string",
      "description": "The description of the transfer you wish to be shown to the recipient."
    },
    "company_name": {
      "type": "string",
      "description": "The name by which the recipient knows you."
    },
    "credit_debit_indicator": {
      "type": "string",
      "description": "Whether the Prenotification is for a future debit or credit.",
      "enum": [
        "credit",
        "debit"
      ]
    },
    "effective_date": {
      "type": "string",
      "format": "date",
      "description": "The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
    },
    "individual_id": {
      "type": "string",
      "description": "Your identifer for the transfer recipient."
    },
    "individual_name": {
      "type": "string",
      "description": "The name of the transfer recipient. This value is information and not verified by the recipient's bank."
    },
    "routing_number": {
      "type": "string",
      "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account."
    },
    "standard_entry_class_code": {
      "type": "string",
      "description": "The Standard Entry Class (SEC) code to use for the ACH Prenotification.",
      "enum": [
        "corporate_credit_or_debit",
        "prearranged_payments_and_deposit",
        "internet_initiated"
      ]
    }
  }
}

Output

{
  "type": "object",
  "description": "ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).",
  "required": [
    "account_number",
    "addendum",
    "company_descriptive_date",
    "company_discretionary_data",
    "company_entry_description",
    "company_name",
    "created_at",
    "credit_debit_indicator",
    "effective_date",
    "id",
    "prenotification_return",
    "routing_number",
    "status",
    "type"
  ],
  "properties": {
    "account_number": {
      "type": "string",
      "description": "The destination account number."
    },
    "addendum": {
      "type": "string",
      "description": "Additional information for the recipient."
    },
    "company_descriptive_date": {
      "type": "string",
      "description": "The description of the date of the notification."
    },
    "company_discretionary_data": {
      "type": "string",
      "description": "Optional data associated with the notification."
    },
    "company_entry_description": {
      "type": "string",
      "description": "The description of the notification."
    },
    "company_name": {
      "type": "string",
      "description": "The name by which you know the company."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the prenotification was created."
    },
    "credit_debit_indicator": {
      "type": "string",
      "description": "If the notification is for a future credit or debit.",
      "enum": [
        "credit",
        "debit"
      ]
    },
    "effective_date": {
      "type": "string",
      "format": "date-time",
      "description": "The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
    },
    "id": {
      "type": "string",
      "description": "The ACH Prenotification's identifier."
    },
    "prenotification_return": {
      "type": "object",
      "description": "If your prenotification is returned, this will contain details of the return.",
      "required": [
        "created_at",
        "return_reason_code"
      ],
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Prenotification was returned."
        },
        "return_reason_code": {
          "type": "string",
          "description": "Why the Prenotification was returned."
        }
      }
    },
    "routing_number": {
      "type": "string",
      "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN)."
    },
    "status": {
      "type": "string",
      "description": "The lifecycle status of the ACH Prenotification.",
      "enum": [
        "pending_submitting",
        "requires_attention",
        "returned",
        "submitted"
      ]
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `ach_prenotification`.",
      "enum": [
        "ach_prenotification"
      ]
    }
  }
}