PaymentCreateDocRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/narmi/main/json-schema/narmi-payment-create-doc-request-schema.json",
  "title": "PaymentCreateDocRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/narmi-payments-api-openapi.yml#/components/schemas/PaymentCreateDocRequest",
  "type": "object",
  "properties": {
    "payee_id": {
      "type": "string",
      "minLength": 1,
      "description": "Identifies payment recipient to the payment processor. Can be fetched via the payees endpoints."
    },
    "amount": {
      "maximum": 1000000000000000,
      "minimum": -1000000000000000,
      "description": "A field that returns the original value in the currency's smallest unit (e.g. cents).",
      "type": "integer"
    },
    "send_date": {
      "type": "string",
      "format": "date"
    },
    "expected_arrival_date": {
      "type": "string",
      "format": "date"
    },
    "type": {
      "type": "string",
      "minLength": 1,
      "description": "The mode of payment, such as check or email."
    },
    "recurring_rule": {
      "type": "string",
      "minLength": 1,
      "description": "Cadence of recurring payment, as per the RFC-5545 specification."
    },
    "ignore_warnings": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ErrorRequest"
      },
      "writeOnly": true,
      "description": "Warning codes to be suppressed during call."
    }
  },
  "required": [
    "amount",
    "expected_arrival_date",
    "payee_id",
    "recurring_rule",
    "send_date",
    "type"
  ],
  "x-stoplight": {
    "id": "dy1brabe9nexg"
  },
  "$defs": {
    "ErrorRequest": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "code"
      ],
      "x-stoplight": {
        "id": "cqk62uhcqgodx"
      }
    }
  }
}