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

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

# PolicyCoverageChangesPayment

Recurring premium/billing arrangement for this transaction, required only if at least one policyUpdateRequest item impacts premium (BASECOVERAGEUPDATE, RIDERADD, RIDERUPDATE).

## 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:
    PaymentForm:
      type: string
      enum:
        - DTCC
        - CREDITCARD
        - ACH
        - CHECK
        - WIRE
        - EXCHANGE
        - EFT
      description: Mode of payment
    ArrangementType:
      type: string
      enum:
        - PAYMENT
        - WITHDRAWAL
        - LOANREPAYMENT
        - REQUIREDMINIMUMDISTRIBUTION
        - PAYOUT
      description: The type of payment such as fixed or flexible
    Frequency:
      type: string
      enum:
        - DAILY
        - EVERYTWOWEEKS
        - MONTHLY
        - SEMIANNUAL
        - BIANNUAL
        - QUARTERLY
        - ANNUAL
        - SINGLEPAYMENT
        - DEFAULT
      description: frequency
    PolicyCoverageChangesBankInformation:
      type: object
      description: Bank account details for the payment; mandatory when method=ACH
      properties:
        nameOnAccount:
          type: string
          description: Name of the account holder on the bank account
          example: abc
        accountStatus:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: Current status of the bank account
          example: ACTIVE
        accountNumber:
          type: string
          description: Bank account number
          example: "1234567890"
        routingNumber:
          type: string
          description: ABA routing number for domestic ACH; mandatory for domestic ACH
          example: "123456789"
        accountType:
          type: string
          enum:
            - CHECKING
            - SAVINGS
          description: Type of bank account
          example: CHECKING
        ibaNumber:
          type: string
          description: International Bank Account Number, for non-domestic accounts
          example: "123456789"
        branchName:
          type: string
          description: Name of the bank branch
          example: XYZ Branch
        address:
          $ref: "#/components/schemas/PolicyCoverageChangesAddress"
      required:
        - nameOnAccount
        - accountStatus
        - accountNumber
        - accountType
    PolicyCoverageChangesAddress:
      type: object
      properties:
        addressType:
          type: string
          enum:
            - RESIDENCE
            - MAILING
            - BUSINESS
          description: Classification of the address
          example: RESIDENCE
        addressLine1:
          type: string
          description: Primary street address line
          example: 123 Main St
        addressLine2:
          type: string
          description: Secondary address line
          example: Apt 4B
        addressLine3:
          type: string
          description: Tertiary address line
          example: Apt 4B
        city:
          type: string
          description: City of the address
          example: San Francisco
        state:
          type: string
          description: State or province
          example: CA
        zipCode:
          type: string
          description: Postal/ZIP code
          example: "94105"
        zipCodeExt:
          type: string
          description: ZIP+4 extension
          example: "4465"
        country:
          type: string
          description: Country of the address (ISO-3166 alpha-2)
          example: US
      required:
        - addressLine1
        - city
        - state
        - country
    PolicyCoverageChangesPayment:
      type: object
      description: >
        Recurring premium/billing arrangement for this transaction, required
        only if at least one policyUpdateRequest item impacts premium
        (BASECOVERAGEUPDATE, RIDERADD, RIDERUPDATE).
      properties:
        referenceNumber:
          type: string
          description: Reference number of the payment/EFT arrangement
          example: 5f2e0c1a-6b3d-4d3f-8b7f-3f7b6d5e4c3a
        method:
          $ref: "#/components/schemas/PaymentForm"
        arrangementType:
          $ref: "#/components/schemas/ArrangementType"
        frequency:
          $ref: "#/components/schemas/Frequency"
        amount:
          type: number
          format: double
          description: Premium/payment amount for this transaction (not a coverage/rider
            face amount)
          example: 250000
        draftDate:
          type: string
          format: date
          description: Date on which the automatic draft occurs
          example: 2023-01-01
        paymentDate:
          type: string
          format: date
          description: Date the payment is applied
          example: 2023-01-01
        externalTransactionId:
          type: string
          description: Identifier from the external payment/billing system for this
            transaction
          example: A12345
        externalArrangementId:
          type: string
          description: Identifier from the external payment/billing system for this
            recurring arrangement
          example: B45678
        party:
          type: array
          description: partyId reference(s) identifying who is paying; must match a
            partyId declared in the top-level parties array
          items:
            type: string
            example: 5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f
        bankInformation:
          $ref: "#/components/schemas/PolicyCoverageChangesBankInformation"
      required:
        - method
        - frequency
        - amount
        - party
```