---
title: "FeatureV3"
url: "https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7/schemas/FeatureV3"
---

> Full API specification: https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7.md

# FeatureV3

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia New Business Annuity API
  version: 0.7.0
servers:
  - url: https://qa.api.zinnia.io
    description: QA Environment
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://uat.api.zinnia.io
    description: UAT Environment
  - url: https://api.zinnia.io
    description: PROD Environment
components:
  schemas:
    WithholdingV3:
      type: object
      additionalProperties: false
      properties:
        withAmount:
          type: number
          description: Withholding amount or percentage value, based on the specified
            withholding amount type.
          format: double
          example: 238500.5
        withAmountDesc:
          type: string
          description: Descriptor indicating how the withholding amount was derived or
            selected.
          enum:
            - INCOMEFROMJOBORPENSIONSTEP2BIII
            - EXTRASTEP4C
            - DEDUCTIONSSTEP4B
            - OTHERINCOMENOTJOBORPENSIONSTEP4
            - DEPENDENTSANDOTHERCREDITSSTEP3TOTAL
            - DEFAULT
            - NOWITHHOLDING
            - SELECTED
            - LOOKUPINTAXINGTABLES
        withAmountType:
          type: string
          description: Type of withholding value being provided.
          enum:
            - AMOUNT
            - PERCENTAGE
            - PRORATA
            - EARNINGSONLY
            - MODIFIEDEARNINGSONLY
            - MAX
            - FREEWITHDRAWALAMOUNT
            - WITHDRAWALUNTILBASIS
        withAuthority:
          type: string
          description: Tax authority to which withholding applies.
          enum:
            - STATE
            - FEDERAL
            - LOCAL
            - NRA
            - BACKUP
    FundTransfer:
      type: object
      additionalProperties: false
      properties:
        srcFundCode:
          type: string
          description: Source fund code from which the amount or percentage will be
            transferred.
        srcFundAllocAmt:
          type: number
          description: Amount allocated from the source fund for transfer, when applicable.
          format: double
          example: 238500.5
        srcFundAllocPercent:
          type: number
          description: Percentage allocated from the source fund for transfer, when
            applicable.
        srcTargetFundCode:
          type: string
          description: Target fund code to which the amount or percentage will be
            transferred.
        srcTargetFundAllocAmt:
          type: number
          description: Amount allocated to the target fund, when applicable.
          format: double
          example: 238500.5
        srcTargetFundAllocPercent:
          type: number
          description: Percentage allocated to the target fund, when applicable.
    FeaturePayment:
      type: object
      additionalProperties: false
      properties:
        amountType:
          type: string
          description: Type of amount specified for the feature payment.
          enum:
            - AMOUNT
            - PERCENTAGE
            - PRORATA
            - EARNINGSONLY
            - MODIFIEDEARNINGSONLY
            - MAX
            - FREEWITHDRAWALAMOUNT
            - WITHDRAWALUNTILBASIS
        amount:
          type: number
          description: Payment amount or percentage value, based on the specified amount
            type.
          format: double
          example: 238500.5
        method:
          type: string
          description: Method by which the payment will be made.
          enum:
            - CREDITCARD
            - CHECK
            - ACH
            - DIGITALPAYMENT
            - WIRE
            - DTCC
        grossNetInd:
          type: string
          description: Indicator specifying whether the payment amount is gross or net of
            applicable deductions.
          enum:
            - NET
            - GROSS
        accountType:
          type: string
          description: Type of account used for the payment.
          enum:
            - CHECKING
            - MONEYMARKETACCOUNT
            - BROKERAGEACCOUNT
            - CREDITCARD
            - DEBITCARD
            - DIGITALPAYMENT
            - MUTUALFUND
            - SAVINGS
            - CERTIFICATEOFDEPOSIT
        abaNumber:
          type: string
          description: American Bankers Association (ABA) routing number for the bank
            account.
        bankName:
          type: string
          description: Name of the financial institution associated with the payment
            account.
        accountNumber:
          type: string
          description: Bank or payment account number used to process the payment.
        payeeContractEntRelationPtr:
          type: string
          description: Reference identifying the payee’s relationship to the contract or
            entity.
    PayoutV3:
      type: object
      additionalProperties: false
      required:
        - payoutOption
      properties:
        payoutOption:
          type: string
          description: Payout option selected for annuity distributions.
          enum:
            - PERIODCERTAIN
            - LIFEONLY
            - LIFEWITHPERIODCERTAIN
            - LIFEWITHINSTALLMENTREFUND
            - LIFEWITHCASHREFUND
            - LESSOROFPERIODCERTAINORLIFE
            - LIFEWITHRETURNOFPREMIUM
            - AMOUNTCERTAIN
            - JOINTLIFEONLY
            - JOINTANDSURVIVOR
        livesType:
          type: string
          description: Indicates whether the payout is based on a single life or joint
            lives.
        primarySurvivorAdjType:
          type: string
          description: Type of adjustment applied to payments upon the primary annuitant’s
            death.
        primarySurvivorAdjPct:
          type: string
          description: Percentage of the original payment payable to the survivor after
            the primary annuitant’s death.
        jointSurvivorAdjType:
          type: string
          description: Type of adjustment applied to payments for a joint survivor.
        jointSurvivorAdjPct:
          type: string
          description: Percentage of the original payment payable to the joint survivor.
        annuityFrequencyCode:
          type: string
          description: Frequency at which annuity payments are made.
          enum:
            - EVERYTWOWEEKS
            - MONTHLY
            - BIMONTHLY
            - ANNUAL
            - SINGLEPAYMENT
            - QUARTERLY
            - SEMIANNUAL
        certainPeriodQualifier:
          type: string
          description: Qualifier indicating the unit of measure for the certain period
            (e.g., years or months).
          enum:
            - ANNUAL
            - BIMONTHLY
            - EVERYTWOWEEKS
            - SINGLEPAYMENT
            - MONTHLY
            - SEMIANNUAL
            - QUARTERLY
        certainPeriod:
          type: string
          description: Length of the guaranteed certain period associated with the payout
            option.
        payoutStartDate:
          type: string
          description: Date on which annuity payout payments begin.
          format: date
        fixedPaymentAmount:
          type: string
          description: Fixed payment amount payable for each annuity distribution.
          format: double
          example: "238500.50"
    FeatureV3:
      type: object
      additionalProperties: false
      required:
        - featureCode
      properties:
        featureCode:
          type: string
          description: Code used to uniquely identify the feature.
        featureName:
          type: string
          description: Name of the feature.
        featureStartDate:
          type: string
          description: Effective start date of the feature.
          format: date
        featureProcessDay:
          type: string
          description: Day of the month on which the feature is processed, when applicable.
          enum:
            - FIRST
            - SECOND
            - THIRD
            - FOURTH
            - FIFTH
            - SIXTH
            - SEVENTH
            - EIGHTH
            - NINTH
            - TENTH
            - ELEVENTH
            - TWELFTH
            - THIRTEENTH
            - FOURTEENTH
            - FIFTEENTH
            - SIXTEENTH
            - SEVENTEENTH
            - EIGHTEENTH
            - NINETEENTH
            - TWENTIETH
            - TWENTYFIRST
            - TWENTYSECOND
            - TWENTYTHIRD
            - TWENTYFOURTH
            - TWENTYFIFTH
            - TWENTYSIXTH
            - TWENTYSEVENTH
            - TWENTYEIGHTH
            - TWENTYNINTH
            - THIRTIETH
            - THIRTYFIRST
        featureDuration:
          type: string
          description: Duration value for the feature based on the specified duration type.
        featureDurationType:
          type: string
          description: Unit of measure used to interpret the feature duration.
          enum:
            - DAYS
            - MONTHS
            - YEARS
            - QUARTERS
            - SEMIANNUALS
            - WEEKS
            - BIWEEKLY
            - SEMIMONTHLY
            - MAXIMUM
        featureFrequency:
          type: string
          description: Frequency at which the feature is applied or processed.
          enum:
            - WEEKLY
            - EVERYTWOWEEKS
            - SEMIMONTHLY
            - MONTHLY
            - BIMONTHLY
            - ANNUAL
            - DAILY
            - SINGLE
            - QUARTERLY
            - SEMIANNUAL
        featureValue:
          type: string
          description: Feature value configured for the contract (amount, percentage, or
            prorated value).
          format: double
          example: "238500.50"
        featureValueType:
          type: string
          description: Type of value represented by the feature value.
          enum:
            - AMOUNT
            - PERCENTAGE
            - WITHDRAWALUNTILBASIS
            - PRORATA
        taxWithholdingIndicator:
          type: string
          description: Indicator specifying whether tax withholding applies to this feature.
          enum:
            - YES
            - NO
        taxFilingStatus:
          type: string
          description: Tax filing status used for withholding determination, when
            applicable.
          enum:
            - SINGLE
            - MARRIED
            - MARRIEDBUTWITHHOLDATHIGHERSINGLERATE
            - MARRIEDFILINGJOINTLY
            - MARRIEDFILINGSEPARATELY
            - HEADOFHOUSEHOLD
            - WIDOWED
            - DOMESTICPARTNER
            - DIVORCED
        withholding:
          $ref: "#/components/schemas/WithholdingV3"
        fund:
          type: array
          description: Fund transfer instructions associated with the feature.
          items:
            $ref: "#/components/schemas/FundTransfer"
        payment:
          type: array
          description: Payment instructions associated with the feature.
          items:
            $ref: "#/components/schemas/FeaturePayment"
        payouts:
          $ref: "#/components/schemas/PayoutV3"
```