ScheduledACHPayment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/narmi/main/json-schema/narmi-scheduled-achpayment-schema.json",
  "title": "ScheduledACHPayment",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/narmi-ach-payments-api-openapi.yml#/components/schemas/ScheduledACHPayment",
  "type": "object",
  "properties": {
    "amount": {
      "maximum": 1000000000000000,
      "minimum": -1000000000000000,
      "description": "A field that returns the original value in the currency's smallest unit (e.g. cents).",
      "type": "integer"
    },
    "memo": {
      "type": "string",
      "default": "",
      "maxLength": 128
    },
    "recurring_rule": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "institution_account": {
      "description": "A field that represents the stringified UUID of a related object.",
      "type": "string",
      "format": "uuid"
    },
    "recipient": {
      "description": "A field that represents the stringified UUID of a related object.",
      "type": "string",
      "format": "uuid"
    },
    "company_id": {
      "type": "string",
      "readOnly": true,
      "maxLength": 10,
      "minLength": 10
    },
    "company_name": {
      "type": "string",
      "readOnly": true,
      "maxLength": 16,
      "minLength": 1
    },
    "std_ent_cls_code": {
      "$ref": "#/$defs/StdEntClsCodeEnum"
    },
    "entry_desc": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "default": ""
    },
    "next_transfer_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "dual_approval_state": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "display_state": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "transaction_type": {
      "allOf": [
        {
          "$ref": "#/$defs/TransactionTypeEnum"
        }
      ],
      "readOnly": true,
      "description": "Indicates whether the Scheduled ACH transaction is a credit (push) or debit (pull).\n\n* `debit` - Pull (debit)\n* `credit` - Push (credit)"
    }
  },
  "required": [
    "amount",
    "entry_desc",
    "institution_account",
    "recipient",
    "recurring_rule",
    "std_ent_cls_code"
  ],
  "x-stoplight": {
    "id": "9gkzfwvfok3wv"
  },
  "$defs": {
    "StdEntClsCodeEnum": {
      "enum": [
        "PPD",
        "CCD",
        "ARC",
        "CTX",
        "POS",
        "WEB",
        "BOC",
        "TEL",
        "MTE",
        "SHR",
        "CIE",
        "POP",
        "RCK"
      ],
      "type": "string",
      "description": "* `PPD` - Batch Personal\n* `CCD` - Batch Corporate\n* `ARC` - Batch Accounts Receivable\n* `CTX` - Batch Corporate Exchange\n* `POS` - Batch Point Of Sale\n* `WEB` - Batch Internet Initiated\n* `BOC` - Batch Backoffice Conversion\n* `TEL` - Batch Telephone Initiated\n* `MTE` - Batch Machine Transfer\n* `SHR` - Batch Shared Network\n* `CIE` - Batch Customer Initiated\n* `POP` - Batch Point Of Purchase\n* `RCK` - Batch Represented Check",
      "x-stoplight": {
        "id": "xgdwqweqfvyee"
      }
    },
    "TransactionTypeEnum": {
      "enum": [
        "debit",
        "credit"
      ],
      "type": "string",
      "description": "* `debit` - Pull (debit)\n* `credit` - Push (credit)",
      "x-stoplight": {
        "id": "acyeadla4mwfp"
      }
    }
  }
}