Payee

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/narmi/main/json-schema/narmi-payee-schema.json",
  "title": "Payee",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/narmi-payees-api-openapi.yml#/components/schemas/Payee",
  "type": "object",
  "properties": {
    "payee": {
      "$ref": "#/$defs/BillPayee"
    }
  },
  "required": [
    "payee"
  ],
  "x-stoplight": {
    "id": "nfevnjkpkwzdk"
  },
  "$defs": {
    "Address": {
      "type": "object",
      "properties": {
        "street_address": {
          "type": "string"
        },
        "street_address_2": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "region_code": {
          "type": "string",
          "description": "A region, province, parish, or any kind of subdivision represented by up to 3 characters. Typically an ISO 2-character state code."
        },
        "postal_code": {
          "type": "string",
          "description": "Typically a five-digit numeric US ZIP Code."
        },
        "country_code": {
          "type": "string",
          "description": "An ISO 3166-1 alpha-2 country code."
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "city",
        "postal_code",
        "region_code",
        "street_address"
      ],
      "x-stoplight": {
        "id": "xatva1xwqb0yk"
      }
    },
    "BillDeliveryOption": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "readOnly": true
        },
        "fee": {
          "maximum": 1000000000000000,
          "minimum": -1000000000000000,
          "description": "A field that returns the original value in the currency's smallest unit (e.g. cents).",
          "type": "integer",
          "readOnly": true
        },
        "transit_days": {
          "type": "integer",
          "readOnly": true
        },
        "date": {
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "date"
      ],
      "x-stoplight": {
        "id": "i4cqeow4pzxv6"
      }
    },
    "BillPayee": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true,
          "description": "Identifies payment recipient to the payment processor. Can be fetched via the payees endpoints."
        },
        "masked_account_number": {
          "type": "string",
          "readOnly": true
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/Type905Enum"
            }
          ],
          "description": "Whether the payment recipient is a person or business."
        },
        "name": {
          "type": "string",
          "description": "Recipient's name."
        },
        "description": {
          "type": "string",
          "description": "Free-form text."
        },
        "phone": {
          "type": "string",
          "description": "Recipient's phone number."
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "Recipient's email address."
        },
        "passphrase": {
          "type": "string",
          "description": "Shared secret phrase between payer and payee."
        },
        "account_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "Destination account number."
        },
        "address": {
          "allOf": [
            {
              "$ref": "#/$defs/Address"
            }
          ],
          "description": "Recipient's address."
        },
        "delivery_options": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BillDeliveryOption"
          }
        }
      },
      "required": [
        "name",
        "type"
      ],
      "x-stoplight": {
        "id": "ewjmueomsaapw"
      }
    },
    "Type905Enum": {
      "type": "string",
      "enum": [
        "personal",
        "business"
      ],
      "x-stoplight": {
        "id": "ulcreuinjodf5"
      }
    }
  }
}