Search
K
Policy

FullSurrenderRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Example:2023-01-01

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Default:false

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

FullSurrenderQuoteTransactionAmounts

object
requestedAmountnumber(double)

Example:100

taxableAmountnumber(double)

Example:100

appliedAmountnumber(double)

Example:100

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

disbursementTypestring

Allowed values:GROSSNETNETNET

disbursementPaymentFormstring

Allowed values:DTCCEFTACHCHECKWIRE

totalChargeAmountnumber(double)

Example:10

Example

AdhocTaxWithheldAmount

object
partyRolestring

Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIER

partyIdstring

A unique identifier linking the party to the policy

Example:Party_PI_1

taxWithholdingTypestring

Allowed values:FEDERALSTATENRABACKUP

withheldAmountnumber(double)

The actual dollar amount withheld for taxes

Example:100

withheldTaxableAmountnumber(double)

The portion of the transaction amount eligible for taxation

Example:100

taxableFlagnumber

Indicates whether the transaction is taxable

Allowed values:true

Example

FullSurrenderQuotePayeeOrBeneficiary

object
partyIdstring

A unique identifier linking the party to the policy

Example:Party_PI_1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

allocationPercentagenumber(double)required

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

disbursementAmountnumber
payeeGrossAmountnumber

Example:20

Example

FullSurrenderQuoteResponseParties

object
partyRolestring

Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIER

partyIdstring

unique identifier linking the party to the policy

Example:Party_PI_1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

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

disbursementAmountnumber
payeeGrossAmountnumber

TBD

Example:20

Example