Search
K
Policy Transactions

CaseCancellationRequest

object
correlationIdstringrequired

Unique identifier to trace the request across systems

Example:218d8992-3783-42ac-b59a-66cbc36adaa2

policyNumberstringrequired

The policy number associated with the case

Example:FIUL463340020

reasonstringrequired

The reason for cancelling the case

Example:User requested cancellation

requestedBystring

The entity requesting cancellation. Derived from the authenticated token.

Example:CLIENT

typestringrequired

The transaction type associated with the case

Example:Reinstatement

subTypestring

The transaction sub-type associated with the case

Example:Reinstatement

Example

CaseCancellationResponse

object
caseIdstring

The unique identifier of the cancelled case

Example:CA0000007516

correlationIdstring

Unique identifier to trace the request across systems

Example:218d8992-3783-42ac-b59a-66cbc36adaa2

caseStatusstring

The updated status of the case

Example:CANCELLED

messagestring

Confirmation message

Example:Case cancellation initiated successfully

Example

EligibleTransactionType

object
transactionTypeCodestring

Transaction type code as string

Example:105

transactionTypeDisplayNamestring

Example:Withdrawal (one time only)

Example

EligibleTransactionsResponse

object
cusipstring

Example:123456789

productCodestring

Example:ADDAARP

eligibleTransactionTypesarray[object]

List of eligible transaction types

Show Child Parameters
Example

LoanRepaymentOneTimeRequest

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

reverseInitiatorboolean

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

transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
payorobject
Show Child Parameters
caseIdstring

Example:CA0000007389

Example