Search
K
Policy Transactions

Zinnia Policy Transactions API.

1.0.6OAS 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

Security
Auth0 (openIdConnect)

Financial Transactions

Financial Transactions

Validation OneTime Premium Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Body

application/json

OneTimePremiumRequest

correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

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

Example:2023-01-01

reverseInitiatorboolean

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

transactionAmountsobjectrequired
Show Child Parameters
payorAny Of
required
Variant 1object
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

overrideboolean

BPM will have to override the rules if this variable is marked as ‘true’

Response

application/json

OneTime Premium Success Response.yaml

TransactionResponse

statusstring

Allowed values:successfailure

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

Body

{ "effectiveDate": "2023-01-01", "transactionAmounts": { "requestedAmount": 0 }, "payor": { "bankId": "bankId" } }
 
application/json