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

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

# ManageRiderPayoutDetails

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.9
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    ManageRiderPaymentFrequency:
      type: string
      enum:
        - MONTHLY
        - QUARTERLY
        - BIANNUALLY
        - ANNUALLY
      description: Maps from the UI Payment Frequency field
      example: MONTHLY
    ManageRiderAmountBasis:
      type: string
      enum:
        - MAXIMUMANNUALBENEFIT
        - SPECIFIEDAMOUNT
        - SPECIFIEDPERCENTAGE
        - REQUIREDMINIMUMDISTRIBUTION
      description: Basis used to determine the payout amount
      example: MAXIMUMANNUALBENEFIT
    ManageRiderPayoutDetails:
      type: object
      properties:
        paymentFrequency:
          $ref: "#/components/schemas/ManageRiderPaymentFrequency"
        paymentStartDate:
          type: string
          format: date
          example: 2026-07-31
          description: Maps from the UI Payment Start Date field
        amountBasis:
          $ref: "#/components/schemas/ManageRiderAmountBasis"
        specifiedAmount:
          type: number
          nullable: true
          example: null
        specifiedPercentage:
          type: number
          nullable: true
          example: null
        currencyCode:
          type: string
          example: USD
        excessWithdrawalConsent:
          type: boolean
          example: false
```
