Search
K
Policy Transactions

Zinnia Policy Transactions API.

1.0.7OAS 3.1

Enterprise API for enforcing policy transactions and validations. This API provides a comprehensive interface for - Policy transaction validation and processing
- Financial and non-financial transaction management
- Policy party management and updates
- Systematic program management
Version History * Draft version 1.0.6
- Added Two Endpoints- Reinstatement eligibility check api, Reinstatement actual transaction api
* Draft Specifications (Subject to Change Upon Review)

API Base URL
  • Server 1:https://dev.api.zinnia.io

    DEV Environment

  • Server 2:https://qa.api.zinnia.io

    QA Environment

Financial Transactions

Financial Transactions

Validation Freelook Cancellation Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Body

application/json

FreeLookCancellationRequest

correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

transactionAmountsobjectrequired
Show Child Parameters
payeeOrBeneficiaryobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
reverseInitiatorboolean

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

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

Response

application/json

Freelook Cancellation Validation Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation/validation

Body

{ "effectiveDate": "effectiveDate", "transactionAmounts": { "disbursementType": "GROSS", "disbursementPaymentForm": "DTCC" }, "parties": [ { "partyId": "Party_PI_1", "paymentForm": "DTCC", "allocationPercentage": 100 } ] }
 
application/json