---
title: "FundTransferRequest"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/FundTransferRequest"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# FundTransferRequest

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.8
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    AmountType:
      type: string
      enum:
        - AMOUNT
        - PERCENTAGE
        - MAX
        - FREEWITHDRAWALAMOUNT
        - WITHDRAWALUNTILBASIS
        - EARNINGSONLY
        - PRORATA
      description: Amount Type selected by user. Following is dropdown list 1. Amount
        -- If selected user should be able to enter Amount for Transaction
        Amount field 2. Percent -- If selected user should be able to enter
        Percentage for Transaction Amount field 3. Max -- If selected user
        should NOT be able to enter Amount. Auto calculated using Maximum
        Withdrawal Amount. 4. Free Withdrawal Amount -- If selected user should
        NOT be able to enter Amount. Auto calcualted using Free Withdrawal
        Amount. 5. Withdraw Until Basis ---- If selected user should NOT be able
        to enter Amount. Auto calcualted using Cost Basis.
    AllocationOption:
      type: string
      enum:
        - PRORATA
        - DOLLAR
        - SPECIFYPERCENTAGE
        - SPECIFIEDFUNDS
        - SPECIFIEDSEGMENTS
        - DEFAULT
        - PECKINGORDER
        - EARNINGSONLY
      description: Defines the format of how the funds are removed, i.e. dollar,
        percentage, pro-rata, etc.
    AdhocFundTransferFromFund:
      type: object
      properties:
        fundId:
          type: string
        requestedAmount:
          type: number
          format: double
          example: 124.124213
        fundSegments:
          type: array
          items:
            allOf:
              - type: object
                properties:
                  segmentId:
                    type: string
              - $ref: "#/components/schemas/AdhocFundTransferFundSegment"
      required:
        - fundId
        - requestedAmount
    AdhocFundTransferToFund:
      type: object
      properties:
        fundId:
          type: string
        requestedAmount:
          type: number
          format: double
          example: 124.124213
        fundSegments:
          type: array
          items:
            $ref: "#/components/schemas/AdhocFundTransferFundSegment"
      required:
        - fundId
        - requestedAmount
    AdhocFundTransferFundSegment:
      type: object
      properties:
        segmentId:
          type: string
        requestedAmount:
          type: number
          format: double
          example: 124.124213
    FundTransferRequest:
      type: object
      properties:
        caseId:
          type: string
          example: CA0000007389
          description: Zinnia Live Case ID
        correlationId:
          type: string
        effectiveDate:
          type: string
          format: date
        reverseInitiator:
          type: boolean
          default: false
        transactionAmounts:
          type: object
          properties:
            amountType:
              $ref: "#/components/schemas/AmountType"
          required:
            - amountType
        fundAllocation:
          type: object
          properties:
            allocationOption:
              $ref: "#/components/schemas/AllocationOption"
          required:
            - allocationOption
        funds:
          type: object
          properties:
            transferFrom:
              type: array
              items:
                $ref: "#/components/schemas/AdhocFundTransferFromFund"
            transferTo:
              type: array
              items:
                $ref: "#/components/schemas/AdhocFundTransferToFund"
          required:
            - transferFrom
            - transferTo
      required:
        - effectiveDate
        - transactionAmounts
        - fundAllocation
        - funds
```