---
title: "IriTransactionAmounts"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/IriTransactionAmounts"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# IriTransactionAmounts

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    IriTransactionAmountType:
      type: string
      description: Indicates how the scheduled amount is defined for the systematic
        program, such as a fixed amount, percentage, maximum available amount,
        free withdrawal amount, withdrawal until basis, earnings only, pro rata
        amount, or modified earnings only.
      enum:
        - AMOUNT
        - PERCENTAGE
        - MAX
        - FREEWITHDRAWALAMOUNT
        - WITHDRAWALUNTILBASIS
        - EARNINGSONLY
    IriDisbursementType:
      type: string
      description: Type of amount for withdrawal such as Gross or Net.
      enum:
        - GROSS
        - NET
    IriDisbursementPaymentForm:
      type: string
      description: Transaction disbursement payment form. Uses the recurring
        disbursement vocabulary with EFT; EXCHANGE is intentionally excluded
        because it applies only to party-level exchange servicing.
      enum:
        - DTCC
        - EFT
        - ACH
        - CHECK
        - WIRE
    IriTransactionAmounts:
      type: object
      properties:
        requestedAmount:
          type: number
          description: Required when amountType is AMOUNT. Must not be provided for
            PERCENTAGE, MAX, FREEWITHDRAWALAMOUNT, WITHDRAWALUNTILBASIS, or
            EARNINGSONLY.
          example: 137547.78
          minimum: 0
          maximum: 9999999999.99
        requestedPercentage:
          type: number
          description: Required when amountType is PERCENTAGE. Must not be provided for
            AMOUNT, MAX, FREEWITHDRAWALAMOUNT, WITHDRAWALUNTILBASIS, or
            EARNINGSONLY.
          example: 10
          minimum: 0
          maximum: 100
        amountType:
          $ref: "#/components/schemas/IriTransactionAmountType"
        disbursementType:
          $ref: "#/components/schemas/IriDisbursementType"
        disbursementPaymentForm:
          $ref: "#/components/schemas/IriDisbursementPaymentForm"
```