Search
K
Policy Transactions

CaseSuccessResponse

object
caseIdstring

Example:CA000000536

correlationIdstring

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

eappIdstring

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

policyNumberstring

Example:ABC37457845

Example

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