Search
K
Policy

PartialWithdrawalOneTimeRequest

object
correlationIdstring
effectiveDatestring(date)
reverseInitiatorboolean

Default:false

transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
externalIdentifiersobject
Show Child Parameters
suppressionarray[object]
Show Child Parameters
Example

PartialWithdrawalQuoteTransactionAmounts

object
requestedAmountnumber(double)

Example:10

appliedAmountnumber(double)

Example:10

taxableAmountnumber(double)

Example:10

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAPERCENTMODIFIEDEARNINGSONLYSUNINCOMEMAXIMIZERONLYLBRMAXIMUMSUNINCOMEMAXIMIZERNETONETIMEACCESSNONSUNINCOMEMAXIMIZERLBRSWDMAXIMUMSUNINCOMEMAXIMIZERGROSSONETIMEACCESSYEARTODATEFIXEDEARNINGSEARNINGSLIQUIDITYFIRSTEARNINGSLIQUIDITYLASTGUARANTEEDWITHDRAWALBENEFITFIXEDMODIFIEDEARNINGSACCUMULATEDEARNINGSLIFEEXPECTANCYDEFAULT

disbursementTypestring

Allowed values:GROSSNETNETNET

disbursementPaymentFormstring

Allowed values:DTCCEFTACHCHECKWIRE

totalChargeAmountnumber(double)

Example:10

Example

PartialWithdrawalQuotePayeeOrBeneficiary

object
partyIdstring
paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEPREMIUMLOAN

allocationPercentagenumber
bankIdstring
disbursementAmountnumber
payeeGrossAmountnumber

Example:20

Example

PartialWithdrawalOneTimeQuoteResponseParties

object
partyRolestring

Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIERSUCCESSORTRUSTEECOVERAGEJOINTINSURED

partyIdstring

unique identifier linking the party to the policy

Example:Party_PI_1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEPREMIUMLOAN

allocationPercentagenumber(double)

The percentage of the total disbursement allocated to the payee

Example:100

bankIdstring

A unique identifier for the financial institution handling the transaction

Example:Bank_1

addressIdstring

A unique identifier for the address associated with the payee or policyholder

Example:1

forBenefitOfOrForFurtherCreditstring

FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)

Example:John Doe

forBenefitOfOrForFurtherCreditIndicatorboolean

Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization.

Example:true

disbursementAmountnumber
payeeGrossAmountnumber

TBD

Example:20

Example

PartialWithdrawalOneTimeQuoteResponse

object
correlationIdstring
transactionAmountsobject
Show Child Parameters
chargesobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
policyobject
Show Child Parameters
Example