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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zinnia

Zinnia Financial Transactions API

Financial Transactions

Documentation Provider Profile APIs.io OpenAPI GitHub

Zinnia Financial 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 Financial Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 44 operations across 44 paths, and defines 140 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.

44 operations 44 paths 140 schemas 43 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 Financial 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 44

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

Financial Transactions 44

Financial Transactions

POST
/bpm/v1/policies/{planCode}/{policyNumber}/basecoverageupdate/eligibilitycheck
base coverage update
post_bpm_v1_policies_planCode_policyNumber_basecoverageupdate_eligibilitycheck 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation/validation
Validation Freelook Cancellation Transaction
validationFreelookCancellationTransaction1 2 params body → 200400500
POST
/bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim/eligibilitycheck
Initial Death Claim Eligibility Check
initialDeathClaimEligibilityCheck 2 params → 200400500
POST
/bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim/validation
Initial Death Claim Validation
initialDeathClaimValidation 2 params body → 200400500
POST
/bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim
Submit Initial Death Claim Transaction
submitInitialDeathClaim 2 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium/validation
Validation OneTime Premium Transaction
validationOneTimePremiumTransactions 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium
Submit OneTime Premium Transaction
submitOneTimePremiumTransaction 2 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium/eligibilitycheck
Eligibility Check OneTime Premium Transaction
eligibilitycheckOneTimePremiumTransactions 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/onetimermd/validation
Validation OneTime RMD Transaction
validationOnetimeRmdTransactions 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/onetimermd
Submit OneTime RMD Transaction
submitOnetimeRmdTransactions 2 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/onetimermd/eligibilitycheck
Eligibility Check OneTime RMD Transaction
eligibilitycheckOnetimeRmdTransactions 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/reinstatement/eligibilitycheck
Eligibility Check Reinstatement Request
reinstatementEligibilityCheck 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/reinstatement
Submit reinstatement transaction request
submitReinstatementTransaction 2 params body → 202400
POST
/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}/validation
Validate Systematic Program Update Transaction
systematicProgramUpdateValidations 3 params body → 200400500
PUT
/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}
Submit Systematic Program Update Transaction
systematicProgramUpdates 3 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}/eligibilitycheck
EligibilityCheck Systematic Program Update Transaction
systematicProgramUpdateeligibilitychecks 3 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/partialwithdrawalonetime/eligibilitycheck
Eligibility Check Partial Withdrawal One Time
partialWithdrawalOneTimeEligibilityCheck1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/partialwithdrawalonetime/validation
Eligibility Check Partial Withdrawal One Time
partialWithdrawalOneTimeValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/partialwithdrawalonetime
Submit Partial Withdrawal OneTime
partialWithdrawalOneTime1 2 params body → 202500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fullsurrender/eligibilitycheck
FullSurrender Eligibility Check endpoint
fullsurrenderEligibilityCheck1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fullsurrender/validation
Fullsurrender Validation Endpoint
fullsurrenderValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fullsurrender
Submit full surrender
fullsurrender1 2 params body → 202500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/newloan/eligibilitycheck
NewLoan Eligibility Check endpoint
nwLoanEligibilityCheck1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/newloan/validation
Fullsurrender Validation Endpoint
newloanRequestValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/newloan
Submit New Loan Request
newLoan1 2 params body → 202500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/validation
Validate Systematic Program Transaction
systematicProgramValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms
Submit Systematic Program Transaction
systematicProgram1 2 params body → 202400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/eligibilitycheck
Eligibility Check Systematic Program Transaction
systematicProgrameligibilitycheck1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime/validation
Validate loan Repayment One Time Transaction
loanrepaymentonetimeValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime
Submit loan Repayment OneTime Transaction
loanrepaymentonetime1 2 params body → 202500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime/eligibilitycheck
EligibilityCheck Loan Repayment OneTime Transaction
loanrepaymentonetimeeligibilitycheck1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/reverserecreate
Request to reverse and recreate
reverserecreate1 2 params body → 202500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/initialpremium/eligibilitycheck
Eligibility Check For Initial Premium
initialPremiumEligibility1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/initialpremium/validation
Validation Check For Initial Premium
initialPremiumValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/initialpremium
Initial Premium Transaction
initialPremium1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fundallocations/eligibilitycheck
Eligibility Check For Fund Allocation
fundAllocationEligibility1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fundallocations/validation
Validation Check For Fund Allocation
fundAllocationValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fundallocations
Fund Allocation Transaction
fundAllocation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fundtransfer/eligibilitycheck
Eligibility Check For Fund Transfer
fundTransferEligibility1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fundtransfer/validation
Validation Check For Fund Transfer
fundTransferValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/fundtransfer
Fund Transfer Transaction
fundTransfer1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/outgoingfundtransfer/eligibilitycheck
Eligibility Check For Outgoing Fund Transfer
outgoingFundTransferEligibility1 2 params → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/outgoingfundtransfer/validation
Validation Check For Outgoing Fund Transfer
outgoingFundTransferValidation1 2 params body → 200400500
POST
/policy/v1/transactions/{planCode}/{policyNumber}/outgoingfundtransfer
Outgoing Fund Transfer Transaction
outgoingFundTransfer1 2 params body → 202500

Schemas 140

The contract defines 140 schemas that model the data the API accepts and returns. The most detailed are Outgoingfundtransfer (36 properties), PartialWithdrawalParty (18 properties), PartialWithdrawalOneTime (15 properties), SystematicProgramUpdate (15 properties). Each schema is shown below with its type and property counts.

BaseAdhocParty
object
2 properties
PolicyTransactionResponse
object
2 properties
Error
object
4 properties
PartialWithdrawalEmail
object
6 properties
AllocationOption
string
Defines the format of how the funds are removed, i.e. dollar, percentage, pro-rata, etc.
PartialWithdrawalCharge
object
4 properties
TaxWithholdingInstructions
object
8 properties 3 required
ReverseRecreate
object
3 properties
OneTimePremiumRequest
object
3 properties
PartialWithdrawalNamePrefix
string
PartialWithdrawalOvernightCheckInfo
object
3 properties
PartialWithdrawalBankAccountPurpose
string
PartialWithdrawalExternalIdentifiers
object
2 properties
FullSurrender
object
9 properties
EmailDetail
object
6 properties
ReinstatementQuoteTransaction
object
5 properties 3 required
FullSurrenderActualTransactionAmounts
object
3 properties
ChargeWaiverIndicator
string
Charge Waiver Indicator
OnetimeRmdRequest
object
11 properties
ReverseRecreateRequest
object
1 property
loanInterestType
string
Loan Interest Type - Selected by user from dropdown values, default to Fixed
PartialWithdrawalParty
object
18 properties 4 required
QualificationType
string
The type of transaction added and processed
TransactionResponse
object
3 properties
PartialWithdrawalFundDistributionSegment
object
3 properties
AdhocTransactionAmount
object
6 properties 6 required
PartialWithdrawalPartyRole
string
OneTimePremiumTransaction
object
6 properties 3 required
PartialWithdrawalEntityType
string
PartialWithdrawalTaxWithholdingInstruction
object
12 properties 2 required
AddressDetail
object
13 properties
InitialPremiumRequest
object
10 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 -…
PartialWithdrawalAddressType
string
DeathNotification
object
7 properties 4 required
PartialWithdrawal.TransactionAmounts
object
12 properties 3 required
PersonalInformation
object
10 properties
SystematicProgramUpdateRequest
object
2 properties
Outgoingfundtransfer
object
36 properties
SystematicProgramSubmitRequest
object
3 properties
SystematicProgramNamedParty
object
Named participant (e.g. servicing agent or policy holder context on the request)
2 properties
FeatureTransactionProduct
object
Product-level transaction classification accompanying the systematic program request
2 properties
AdhocFundTransferFromFund
object
3 properties 2 required
TransactionReason
string
Optional Reason for this transaction
PartialWithdrawalPreferredContactMethod
string
TaxRateToUse
string
How tax rate should be applied for withholding
PartialWithdrawalPhone
object
11 properties
FilingStatus
string
AdhocDisbursementParty
object
7 properties 3 required
Charge
object
3 properties
Correction
object
2 properties
PaymentForm
string
Mode of payment
PayeeOrBeneficiary
object
4 properties
PartialWithdrawalDisbursementType
string
PartialWithdrawalDistributionCode
string
TransactionTaxBasis
object
7 properties
PartialWithdrawalSuppression
object
2 properties
Errors
object
4 properties
ReinstatementErrorResponse
object
2 properties
LoanRepaymentOneTime
object
6 properties
DeathClaimDocument
object
3 properties
LoanType
string
Loan Types - Selected by user from dropdown values, default to Non-Preferred Standard Loan
Frequency
string
frequency
ChargeType
string
Charge Type
AdhocFundDistributions
object
5 properties
PartialWithdrawalAllocationOption
string
Defines how funds are removed for the partial withdrawal
InitialDeathClaimRequest
object
9 properties 4 required
PartialWithdrawalEmergencyType
string
PartialWithdrawalDisbursementPaymentForm
string
PartialWithdrawalTaxFormType
string
AdhocFundTransferToFund
object
3 properties 2 required
SystematicProgramUpdate
object
15 properties 2 required
PartialWithdrawalW4rContribution
string
DeathDetails
object
4 properties
PartialWithdrawalOrganisationDetails
object
6 properties
SystematicProgramContactMfa
object
Contact channels for multi-factor authentication on systematic program transactions
2 properties
PartialWithdrawalFundDistribution
object
6 properties
DisbursementPaymentForm
string
The type of disbursement method such as DTCC,EFT or credit card.Default EFT.
PartyEmail
object
2 properties
PartialWithdrawalOneTime
object
Request body for partial withdrawal one-time eligibility, validation, and submit endpoints.
15 properties 4 required
PartialWithdrawalEmailType
string
PartialWithdrawalBankAccountType
string
PartialWithdrawalHardshipType
string
PartialWithdrawalTransactionType
string
Transaction type for partial withdrawal one-time requests
DeathClaimPolicy
object
5 properties 3 required
PartialWithdrawalPartyType
string
FullSurrenderRequest
object
2 properties
PartyAddress
object
2 properties
FundAllocationChangeRequest
object
5 properties 2 required
NewLoan
object
7 properties 5 required
PartialWithdrawalChargeWaiverIndicator
string
PartialWithdrawalSignature
object
4 properties
PartialWithdrawalIdentificationType
string
LoanRepaymentOneTimeRequest
object
1 property
DeathClaimRiderClaim
object
4 properties
FreeLookCancellationRequest
object
1 property
PartyPhoneNumber
object
2 properties
PartialWithdrawalTransactionReason
string
Reason for the partial withdrawal one-time transaction
ReinstatementQuoteRequest
object
PartialWithdrawalOvernightAccountType
string
LineOfBusiness
string
Line of business annuity or life
PartyIdentifier
object
8 properties
FundTransferRequest
object
7 properties 4 required
PartialWithdrawalPersonalInformation
object
11 properties
AdhocFundTransferFundSegment
object
2 properties
DisbursementType
string
The type of amount for withdrawal such as Gross or Net
PartialWithdrawalFilingStatus
string
Filing status for partial withdrawal tax withholding
TransactionAmounts
PartialWithdrawalFundAllocation
object
1 property 1 required
PartialWithdrawalOneTimeRequest
object
Partial withdrawal one-time transaction request including transaction amounts, fund allocation, parties, tax withholding, and signatures.
2 properties
AdhocParty
TransactionAcceptedResponse
object
4 properties
PartialWithdrawalWithdrawalReason
string
PartialWithdrawalTrustType
string
PartialWithdrawalAddress
object
10 properties
PartialWithdrawalW4r
object
4 properties
FreeLookCancellation
object
6 properties 3 required
PartialWithdrawalAmountType
string
DeathClaimParty
object
11 properties 3 required
FundAllocation
object
4 properties 2 required
TransactionExchange
object
9 properties
ExchangeDescription
string
Indicates the type of exchange being conducted
TaxWithholdingType
string
ReinstatementSubmitRequest
object
7 properties 6 required
PartialWithdrawalBankAccountStatus
string
PartialWithdrawalBankDetails
object
11 properties
PartialWithdrawalSuppressionType
string
AdhocFundAllocation
object
1 property 1 required
PartialWithdrawalPhoneType
string
ArrangementType
string
The type of payment such as fixed or flexible
AdhocSystematicProgram
object
13 properties 2 required
PartialWithdrawalNameSuffix
string
PartialWithdrawalIdentification
object
5 properties
InvestmentType
string
TBD
PartyRole
string
Party Role
PartialWithdrawalDistributionAmountType
string
PartialWithdrawalGender
string
PartialWithdrawalChargeType
string
NewLoanRequest
object
1 property
PhoneDetail
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Zinnia publishes across the network.

Zinnia Annuity Health Check API
AE Profile APIs.io
Zinnia Annuity Version 1 API
AE Profile APIs.io
Zinnia Annuity Version 2 API
AE Profile APIs.io
Zinnia Attachment API
AE Profile APIs.io
Zinnia Authorization Status Update API
AE Profile APIs.io
Zinnia Case Instance API
AE Profile APIs.io
Zinnia Client Case API
AE Profile APIs.io
Zinnia Comments API
AE Profile APIs.io
Zinnia Dataset API
AE Profile APIs.io
Zinnia Details API
AE Profile APIs.io
Zinnia Documents V2 API
AE Profile APIs.io
Zinnia Documents V3 API
AE Profile APIs.io
#Financial Transactions
← Back to Z APIs
API Details
ID
zinnia:zinnia-financial-transactions-api
Base URL
https://qa.api.zinnia.io
Docs
https://developers.zinnia.com/apis/policy-transactions-1-0-2/docs
Provider
Zinnia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zinnia-financial-transactions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zinnia-financial-transactions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zinnia Financial 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.