How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zinnia Policy - Transactions API

All Apis related to policy operations

Zinnia Policy - Transactions API is one of 42 APIs that Zinnia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Policy - Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.8.

Requests are made against 2 base URLs: https://dev.api.zinnia.io, https://qa.api.zinnia.io.

5 operations 5 paths 24 schemas 1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.8
Base URL
https://qa.api.zinnia.io
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

Zinnia Policy - Transactions API declares 1 security scheme for authenticating requests. It supports OpenID Connect (Auth0) discovered at https://login.dev.zinnia.com/.well-known/openid-configuration.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Policy - Transactions 5

All Apis related to policy operations

GET
/bpm/actuator/health
Zahara BPM Health Check
getHealth → 200503
POST
/policy/v1/transactions/case
Create case for transaction
createCase body → 201400401403500
PUT
/policy/v1/cases/{caseId}/cancel
Cancel a case
cancelCase 1 param body → 202400401403404409500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/quote
Systematic Program Quote Request
systematicProgramQuote 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/canceltransaction
Cancel Transaction
cancelTransaction1 2 params body → 202500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are AdhocSystematicProgram (13 properties), CaseCancellationRequest (7 properties), AdhocDisbursementParty (7 properties), CreateCaseRequest (6 properties). Each schema is shown below with its type and property counts.

ValidationResponse
object
5 properties
AmountType
string
Amount Type selected by user. Following is dropdown list 1. Amount -- If selected user should be able to enter Amount for Transaction Amount field 2. Percent -…
PartyRole
string
Party Role
PaymentForm
string
Mode of payment
BaseAdhocParty
object
2 properties
IdentifierInstance
object
An object representing an identifier and its corresponding value.
2 properties
CreateCaseRequest
object
6 properties 4 required
TransactionResponse
object
3 properties
Error
object
4 properties
AdhocSystematicProgram
object
13 properties 2 required
SystematicProgramQuoteRequest
object
2 properties
CaseSuccessResponse
object
4 properties
SystematicProgramQuote
object
5 properties 2 required
ArrangementType
string
The type of payment such as fixed or flexible
DisbursementType
string
The type of amount for withdrawal such as Gross or Net
CaseCancellationResponse
object
4 properties
CancelTransactionRequest
object
1 property
CaseCancellationRequest
object
7 properties 5 required
Frequency
string
frequency
TransactionAcceptedResponse
object
4 properties
AdhocDisbursementParty
object
7 properties 3 required
ServerErrorResponse
object
4 properties
AccessDeniedResponse
object
4 properties
CancelTransaction
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-policy-transactions-api-openapi.yml Raw ↑

Other APIs Zinnia publishes across the network.

Zinnia Annuity Health Check API
Zinnia Annuity Version 1 API
Zinnia Annuity Version 2 API
Zinnia Attachment API
Zinnia Authorization Status Update API
Zinnia Case Instance API
Zinnia Client Case API
Zinnia Comments API
Zinnia Dataset API
Zinnia Details API
Zinnia Documents V2 API
Zinnia Documents V3 API
Where this information came from

This is an independent, third-party profile of Zinnia Policy - Transactions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.