Policy Transactions
PolicyCoverageChangesFlatExtraTemporary
objectTemporary flat extra premium
typestringrequired
Whether the flat extra premium is permanent or temporary
Allowed values:TEMPORARY
Example:TEMPORARY
amountnumber(double)required
Flat extra premium amount
Example:250000
durationintegerrequired
Duration the flat extra applies for
Example:5
durationTypestringrequired
Unit of measure for the duration
Allowed values:YEARSMONTHS
Example:YEARS
Example
PolicyCoverageChangesPayment
objectRecurring premium/billing arrangement for this transaction, required only if at least one policyUpdateRequest item impacts premium (BASECOVERAGEUPDATE, RIDERADD, RIDERUPDATE).
referenceNumberstring
Reference number of the payment/EFT arrangement
Example:5f2e0c1a-6b3d-4d3f-8b7f-3f7b6d5e4c3a
methodstringrequired
Mode of payment
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEEFT
arrangementTypestring
The type of payment such as fixed or flexible
Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT
frequencystringrequired
frequency
Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALBIANNUALQUARTERLYANNUALSINGLEPAYMENTDEFAULT
amountnumber(double)required
Premium/payment amount for this transaction (not a coverage/rider face amount)
Example:250000
draftDatestring(date)
Date on which the automatic draft occurs
Example:2023-01-01
paymentDatestring(date)
Date the payment is applied
Example:2023-01-01
externalTransactionIdstring
Identifier from the external payment/billing system for this transaction
Example:A12345
externalArrangementIdstring
Identifier from the external payment/billing system for this recurring arrangement
Example:B45678
partyarray[string]required
partyId reference(s) identifying who is paying; must match a partyId declared in the top-level parties array
Example:5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f
bankInformationobject
Bank account details for the payment; mandatory when method=ACH
Show Child Parameters
Example
PolicyCoverageChangesBankInformation
objectBank account details for the payment; mandatory when method=ACH
nameOnAccountstringrequired
Name of the account holder on the bank account
Example:abc
accountStatusstringrequired
Current status of the bank account
Allowed values:ACTIVEINACTIVE
Example:ACTIVE
accountNumberstringrequired
Bank account number
Example:1234567890
routingNumberstring
ABA routing number for domestic ACH; mandatory for domestic ACH
Example:123456789
accountTypestringrequired
Type of bank account
Allowed values:CHECKINGSAVINGS
Example:CHECKING
ibaNumberstring
International Bank Account Number, for non-domestic accounts
Example:123456789
branchNamestring
Name of the bank branch
Example:XYZ Branch
addressobject
Show Child Parameters
Example
PolicyCoverageChangesAddress
objectaddressTypestring
Classification of the address
Allowed values:RESIDENCEMAILINGBUSINESS
Example:RESIDENCE
addressLine1stringrequired
Primary street address line
Example:123 Main St
addressLine2string
Secondary address line
Example:Apt 4B
addressLine3string
Tertiary address line
Example:Apt 4B
citystringrequired
City of the address
Example:San Francisco
statestringrequired
State or province
Example:CA
zipCodestring
Postal/ZIP code
Example:94105
zipCodeExtstring
ZIP+4 extension
Example:4465
countrystringrequired
Country of the address (ISO-3166 alpha-2)
Example:US
Example
PolicyCoverageChangesOneTimePayment
objectOne-time payment accompanying this transaction, present only when the transaction includes a one-time payment
requestedAmountnumber(double)required
Gross amount of the one-time payment being requested
Example:25000
partiesarray[object]required
Payor/party details for this one-time payment
>= 1 items
Show Child Parameters
Example