Search
K
Policy Transactions

PartialWithdrawalOneTime

object

Request body for partial withdrawal one-time eligibility, validation, and submit endpoints.

correlationIdstring

The unique ID to track transaction request across all systems

Example:test-112132141

effectiveDatestring(date)required

Date when the transaction was originally scheduled or expected to happen. It can be a non-business day

Example:2026-03-17

reverseInitiatorboolean

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

Default:false

selfServeFlowboolean

Whether the request originated from a self-serve flow

transactionTypestring

Transaction type for partial withdrawal one-time requests

Allowed values:PARTIAL_WITHDRAWAL

Example:PARTIAL_WITHDRAWAL

externalIdentifiersobject
Show Child Parameters
transactionReasonstring

Reason for the partial withdrawal one-time transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCENOTRANSACTIONREASONSTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESSDATEOFDEATHINITIALDEATHNOTIFICATIONPRODUCTDEFAULTAMOUNTGWBRIDERDISBURSEMENTGWBPHASECHANGEFREQUENCYPREMIUMLOANPAYMENTDUEDATE

Example:ONETIMEPREMIUM

transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
partiesarray[object]required
Show Child Parameters
chargesarray[object]
Show Child Parameters
suppressionarray[object]
Show Child Parameters
signaturesarray[object]
Show Child Parameters
Example

PartialWithdrawalTransactionType

string

Transaction type for partial withdrawal one-time requests

Allowed values:PARTIAL_WITHDRAWAL

Example

PartialWithdrawalExternalIdentifiers

object
externalTransactionIdstring

The unique ID to identify transaction on carrier side

Example:14141414

referenceNumberstring

The unique payment reference number for all premium-related transactions by carrier

Example:141414141

Example

PartialWithdrawalTransactionReason

string

Reason for the partial withdrawal one-time transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCENOTRANSACTIONREASONSTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESSDATEOFDEATHINITIALDEATHNOTIFICATIONPRODUCTDEFAULTAMOUNTGWBRIDERDISBURSEMENTGWBPHASECHANGEFREQUENCYPREMIUMLOANPAYMENTDUEDATE

Example

PartialWithdrawalFundAllocation

object
allocationOptionstringrequired

Defines how funds are removed for the partial withdrawal

Allowed values:DEFAULTFIXEDPRORATAVARIABLEPRORATAPRORATASPECIFIEDFUNDSSPECIFIEDSEGMENTS

Example:PRORATA

Example