Policy Transactions
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
PolicyCoverageChangesOneTimePaymentParty
objectpartyIdstringrequired
partyId reference identifying the source/payor of this one-time payment; must reference an entry in the transaction’s top-level parties array
Example:Party_PI_1
paymentFormstringrequired
Mode of payment
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEEFT
bankIdstring
Reference identifier of the bank account funding this payment
Example:bank_1
partyRolestringrequired
Role the party plays on the policy for this transaction
Allowed values:INSUREDOWNERBENEFICIARYPAYORTRUSTEE
Example:INSURED
Example
PolicyCoverageChangesIllustration
objectsourcestring
System that generated the illustration supporting the requested change
Allowed values:ZINNIAEXTERNAL
Example:ZINNIA
illustrationIdstring
Unique identifier of the illustration
Example:Q12345
Example