--- title: "EligibilityCheck Loan Repayment OneTime Transaction" url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/operations/loanrepaymentonetimeeligibilitycheck1" --- > Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md # EligibilityCheck Loan Repayment OneTime Transaction `POST` `/policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime/eligibilitycheck` Operation ID: `loanrepaymentonetimeeligibilitycheck1` ## Path parameters - `planCode` (string, required) - `policyNumber` (string, required) ## Responses - `200` - Eligibility Check Success Response - `400` - Eligibility Check Failure Response - `500` - Unexpected error occured, please check server logs ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Zinnia Policy Transactions API. version: 1.0.8 servers: - url: https://dev.api.zinnia.io description: DEV Environment - url: https://qa.api.zinnia.io description: QA Environment paths: /policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime/eligibilitycheck: post: x-kong-plugin-pre-function: config: access: - > local path = kong.request.get_path() local new_path = path:gsub("^/policy/v1/transactions", "/bpm/v1/policies") kong.service.request.set_path(new_path) tags: - Financial Transactions summary: EligibilityCheck Loan Repayment OneTime Transaction operationId: loanrepaymentonetimeeligibilitycheck1 parameters: - name: planCode in: path required: true schema: type: string - name: policyNumber in: path required: true schema: type: string responses: "200": description: Eligibility Check Success Response content: application/json: schema: $ref: "#/components/schemas/TransactionResponse" examples: success: $ref: "#/components/examples/successTransactionResponse" "400": description: Eligibility Check Failure Response content: application/json: schema: $ref: "#/components/schemas/TransactionResponse" examples: failure: $ref: "#/components/examples/failureTransactionResponse" "500": description: Unexpected error occured, please check server logs security: - Auth0: [] security: - Auth0: [] components: schemas: TransactionResponse: type: object properties: status: type: string enum: - success - failure error: type: array items: $ref: "#/components/schemas/Error" quoteResponse: type: object Error: type: object properties: errorCode: type: string example: BPM.NM.002 description: This is the NIGO id generated by BPM system attribute: type: string error: type: string description: This is the error generated by BPM system resolution: type: string description: Resolution generated by BPM system to resolve the error examples: successTransactionResponse: value: status: success quoteResponse: status: Success message: Request successful data: correlationId: 657b717dcf55411abf9ef067 transactionAmounts: requestedAmount: 25 calculatedAmount: null appliedAmount: 25 policy: id: 659fdafc075b950b7bd00feb event: InterestCreditMatch carrierID: SB tpaID: tpa-12345 lineOfBusiness: LIFE planName: SB UL Premium Match productType: UNIVERSALLIFE marketingName: Everly Life shortName: SB UL distribution: THIRDPARTYDIRECTTOCONSUMER banding: NOPREMIUMBANDING planCode: SBFIXUL1 glPlanCode: V2201 holdingForm: INDIVIDUAL renewable: null qualificationType: NONQUALIFIED policyTerm: 20 policyYear: 1 monthOfYear: 1 policyNumber: BPM0000001 policyStatus: ACTIVE nonforfeitureOption: null issueType: FULLUNDERWRITING residenceState: VT issueState: VT premiumFrequency: MONTHLY currency: USD policyStartDate: 2023-12-27 applicationDate: 2023-12-27 issueDate: 2023-12-27 effectiveDate: 2024-01-11T00:00:00.000Z contestabilityStartDate: 2023-12-27 contestabilityEndDate: 2025-12-26 policyDeliveryDate: 2023-12-27 previousPolicyAnniversaryDate: 2023-12-27 previousPolicyMonthiversaryDate: 2023-12-27 nextAnniversaryDate: 2024-12-27 maturityDate: 2125-12-26 policyTerminationDate: null dateOfDeath: null initialPaymentExpiryDate: 2024-01-10 nextMonthivesaryDate: 2024-01-27 costBasis: 105 costBasisDate: 2024-11-04 conversionDate: null policyValues: beginningAcctValue: 35.759837 endingAcctValue: 60.759837 minRequiredAcctValue: 0 acctValueByPolicyYear: 0 unloanedPortionOfAcctValue: 60.759837 loanedPortionOfAcctValue: 0 surrenderValue: 60.759837 netAmountAtRisk: 499920 initialPremiumRequestAmount: 80 initialPremiumAppliedAmount: 80 initialPaymentAmountReceivedDate: 2023-12-27 cumulativePremSinceIssue: 105 totalYTDPremiumAmount: 105 mecAuthorization: false projectedLapseIndicator: null policyGainAmount: 0 loanValues: totalLoanBalance: 0 totalLoanPrincipal: 0 loanPayoffAmount: 0 maxLoanAmount: 60.759837 minLoanAmount: 0 totalLoanAccruedInterest: 0 lastLoanInterestDueDate: null totalNumberOfLoan: 0 loanInterestMethod: ARREARS totalYTDLoanTaken: 0 loanRepaymentType: null minLoanRepayment: 1 withDrawalValues: totalWithdrawalAmount: 0 freeWithdrawalAmount: null minWithdrawalAmount: 1 maxWithdrawalAmount: 60.759837 annualWithLimNoCovDecrease: null maxWithdrawalRequestDuringVestingPeriod: 1 maxWithdrawalRequestAfterVestingPeriod: 12 totalYTDWithdrawalTaken: 0 numberOfWithdrawal: 0 withdrawalAllowedStartDate: 2023-12-27 testValues: guidelinePremiumTestDate: 2024-11-04 definitionOfLifeInsurance: GPT guidelineSinglePremium: 68933.997746 guidelineLevelPremium: 5122.813261 amountExcessToGuideline: 0 totalGuidelineLevelPremiumSinceIssue: 5122.813261 mecTestDate: 2024-11-04 amountExcessToMEC: 0 mecStatusDate: null mecStatus: false sevenPayTestBasis: 185 sevenPayPremium: 25074.702628 sevenPayStartDate: 2023-12-27 sevenPayPeriod: 2030-12-26 sevenPayLimit: 25074.702628 yearInPeriod: 1 timestamp: 2024-01-11T12:11:40.723Z deathBenefit: deathBenefitOption: LEVEL dboEffectiveDate: 2023-12-27 dboChangedEffectiveDate: null deathBenefitAgeGuarantee: 38 coverage: id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.731Z totalCoverageAmount: 500000 cumGrossDeathBenefitAmount: 500000 minCoverageAmount: 10000 maxCoverageAmount: 10000000 coverageChangeEffectiveDate: 2024-12-27 coverageBand: BAND3 maxAnnualCoverageChangeAllowedPerPolicy: 1 minCoverageDecreaseAmount: 10000 maxCoverageDecreaseAmount: 490000 maxAgeNoCovAmountDecrease: 120 coverageAmountDecreaseAllowed: 1 minCoverageIncreaseAmount: 1 maxCoverageIncreaseAmount: 9500000 maxAgeNoCovAmountIncrease: 50 coverageAmountIncreaseAllowed: 1 coverageLayers: - coverageID: Base_Coverage coverageType: Base coverageName: SB UL Premium Match productCode: SBFIXUL1 currentAmount: 500000 orignalCoverageAmount: 500000 minCoverageAmount: 10000 maxCoverageAmount: 10000000 grossDeathBenefitAmount: 500000 lowDeathBenefitAmount: 500000 coverageChangeAmount: 0 coverageEffectiveDate: 2023-12-27 coverageChangeEffectiveDate: null coverageTerminationDate: null unitOfCoverage: 500 valuePerUnitOfCoverage: 1000 premiumFrequency: null guidelineSinglePremium: 68933.997746 guidelineLevelPremium: 5122.813261 sevenPayPremium: 25074.702628 coverageParticipants: - partyID: Party_PI_1 issueAge: 18 riskClass: Standard Tobacco subStandardRating: None flatExtra: - flatExtraType: null flatExtraDuration: 0 flatExtraAmount: 0 flatExtraStartDate: null - coverageID: Rider_SBLCHR coverageType: RIDER coverageName: Chronic Illness Accelerated Death Benefit Rider productCode: SBLCHR currentAmount: null orignalCoverageAmount: null minCoverageAmount: null maxCoverageAmount: null grossDeathBenefitAmount: null lowDeathBenefitAmount: null coverageChangeAmount: 0 coverageEffectiveDate: 2023-12-27 coverageChangeEffectiveDate: null coverageTerminationDate: 2125-12-26 unitOfCoverage: null valuePerUnitOfCoverage: null premiumFrequency: null guidelineSinglePremium: null guidelineLevelPremium: null sevenPayPremium: null coverageParticipants: - partyID: Party_PI_1 issueAge: 18 riskClass: null subStandardRating: null flatExtra: [] - coverageID: Rider_SBLCRI coverageType: RIDER coverageName: Critical Illness Accelerated Death Benefit Rider productCode: SBLCRI currentAmount: null orignalCoverageAmount: null minCoverageAmount: null maxCoverageAmount: null grossDeathBenefitAmount: null lowDeathBenefitAmount: null coverageChangeAmount: 0 coverageEffectiveDate: 2023-12-27 coverageChangeEffectiveDate: null coverageTerminationDate: 2125-12-26 unitOfCoverage: null valuePerUnitOfCoverage: null premiumFrequency: null guidelineSinglePremium: null guidelineLevelPremium: null sevenPayPremium: null coverageParticipants: - partyID: Party_PI_1 issueAge: 18 riskClass: null subStandardRating: null flatExtra: [] - coverageID: Rider_SBLTRM coverageType: RIDER coverageName: Terminal Illness Accelerated Death Benefit Rider productCode: SBLTRM currentAmount: null orignalCoverageAmount: null minCoverageAmount: null maxCoverageAmount: null grossDeathBenefitAmount: null lowDeathBenefitAmount: null coverageChangeAmount: 0 coverageEffectiveDate: 2023-12-27 coverageChangeEffectiveDate: null coverageTerminationDate: 2125-12-26 unitOfCoverage: null valuePerUnitOfCoverage: null premiumFrequency: null guidelineSinglePremium: null guidelineLevelPremium: null sevenPayPremium: null coverageParticipants: - partyID: Party_PI_1 issueAge: 18 riskClass: null subStandardRating: null flatExtra: [] - coverageID: Rider_OPR coverageType: RIDER coverageName: Overloan Protection Rider productCode: SBLOPR currentAmount: null orignalCoverageAmount: null minCoverageAmount: null maxCoverageAmount: null grossDeathBenefitAmount: null lowDeathBenefitAmount: null coverageChangeAmount: 0 coverageEffectiveDate: 2023-12-27 coverageChangeEffectiveDate: null coverageTerminationDate: 2125-12-26 unitOfCoverage: null valuePerUnitOfCoverage: null premiumFrequency: null guidelineSinglePremium: null guidelineLevelPremium: null sevenPayPremium: null coverageParticipants: - partyID: Party_PI_1 issueAge: 18 riskClass: null subStandardRating: null flatExtra: [] version: 1 riders: - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.729Z type: RIDER riderName: Chronic Illness Accelerated Death Benefit Rider riderElected: ELECTED riderCode: SBLCHR effectiveDate: 2023-12-27 terminationDate: 2125-12-26 status: ACTIVE coverageID: Rider_SBLCHR amount: null riderParticipant: - insuredID: Party_PI_1 insuredAgeAtIssue: 18 charge: chargeID: null value: null effectiveRate: null nextEvaluationDate: null riderExerciseCharge: null maxChronicIllnessBenefitPct: 50 maxPeriodicPaymentPeriod: 120 claimStatus: null riderExerciseChargeRate: null nextEvaluationDate: null riderPaymentDate: null riderPaymentAmount: null paymentMode: null paymentOption: null maxCriticalIllnessBenefitPct: null t1MaxCriticalIllnessBenefitPct: null t1MaxCriticalIllnessBenefitAmount: null t2MaxCriticalIllnessBenefitPct: null t2MaxCriticalIllnessBenefitAmount: null t1CriticalRiderPaymentDate: null t1CriticalRiderPaymentAmount: null t2CriticalRiderPaymentDate: null t2CriticalRiderPaymentAmount: null terminalRiderPaymentAmount: null version: 1 - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.729Z type: RIDER riderName: Critical Illness Accelerated Death Benefit Rider riderElected: ELECTED riderCode: SBLCRI effectiveDate: 2023-12-27 terminationDate: 2125-12-26 status: ACTIVE coverageID: Rider_SBLCRI amount: null riderParticipant: - insuredID: Party_PI_1 insuredAgeAtIssue: 18 charge: chargeID: null value: null effectiveRate: null nextEvaluationDate: null riderExerciseCharge: null maxChronicIllnessBenefitPct: null maxPeriodicPaymentPeriod: null claimStatus: null riderExerciseChargeRate: null nextEvaluationDate: null riderPaymentDate: null riderPaymentAmount: null paymentMode: null paymentOption: null maxCriticalIllnessBenefitPct: 50 t1MaxCriticalIllnessBenefitPct: 5 t1MaxCriticalIllnessBenefitAmount: 5000 t2MaxCriticalIllnessBenefitPct: 50 t2MaxCriticalIllnessBenefitAmount: 500000 t1CriticalRiderPaymentDate: null t1CriticalRiderPaymentAmount: null t2CriticalRiderPaymentDate: null t2CriticalRiderPaymentAmount: null terminalRiderPaymentAmount: null version: 1 - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.729Z type: RIDER riderName: Overloan Protection Rider riderElected: ELECTED riderCode: SBLOPR effectiveDate: 2023-12-27 terminationDate: 2125-12-26 status: ACTIVE coverageID: Rider_SBLOPR amount: null riderParticipant: - insuredID: Party_PI_1 insuredAgeAtIssue: 18 charge: chargeID: null value: null effectiveRate: null nextEvaluationDate: null riderExerciseCharge: null maxChronicIllnessBenefitPct: null maxPeriodicPaymentPeriod: null claimStatus: null riderExerciseChargeRate: null nextEvaluationDate: null riderPaymentDate: null riderPaymentAmount: null paymentMode: null paymentOption: null maxCriticalIllnessBenefitPct: null t1MaxCriticalIllnessBenefitPct: null t1MaxCriticalIllnessBenefitAmount: null t2MaxCriticalIllnessBenefitPct: null t2MaxCriticalIllnessBenefitAmount: null t1CriticalRiderPaymentDate: null t1CriticalRiderPaymentAmount: null t2CriticalRiderPaymentDate: null t2CriticalRiderPaymentAmount: null terminalRiderPaymentAmount: null version: 1 - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.729Z type: RIDER riderName: Terminal Illness Accelerated Death Benefit Rider riderElected: ELECTED riderCode: SBLTRM effectiveDate: 2023-12-27 terminationDate: 2125-12-26 status: ACTIVE coverageID: Rider_SBLTRM amount: null riderParticipant: - insuredID: Party_PI_1 insuredAgeAtIssue: 18 charge: chargeID: null value: null effectiveRate: null nextEvaluationDate: null riderExerciseCharge: null maxChronicIllnessBenefitPct: null maxPeriodicPaymentPeriod: null claimStatus: null riderExerciseChargeRate: null nextEvaluationDate: null riderPaymentDate: null riderPaymentAmount: null paymentMode: null paymentOption: null maxCriticalIllnessBenefitPct: null t1MaxCriticalIllnessBenefitPct: null t1MaxCriticalIllnessBenefitAmount: null t2MaxCriticalIllnessBenefitPct: null t2MaxCriticalIllnessBenefitAmount: null t1CriticalRiderPaymentDate: null t1CriticalRiderPaymentAmount: null t2CriticalRiderPaymentDate: null t2CriticalRiderPaymentAmount: null terminalRiderPaymentAmount: null version: 1 systematicPrograms: - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.730Z arrType: PAYMENT arrangementID: Arr_1 allocationOptionType: DOLLAR reason: PREMIUMREASON numberOfOccurrence: null loanRepaymentType: null disbursementType: null status: ACTIVE paymentForm: EFT frequency: MONTHLY requestedDate: 2023-12-27 startDate: 2024-01-27 endDate: 2043-11-27 lastActivityDate: 2023-12-27 nextActivityDate: 2024-01-27 amountType: AMOUNT amount: 80 payors: - partyRole: Payee partyID: Party_PI_1 bankId: Bank_1 percentage: 100 payees: null version: 1 policyFeatures: - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.733Z featureType: freeLook startDate: null endDate: 2024-01-26 status: null period: 30 effectiveDate: null totalRequiredAmount: null totalMinimumRequiredAmount: null paymentAmount: null totalPaymentAmount: null uwDecision: null approvalDate: null version: 1 - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.733Z featureType: lapseAssessment startDate: null endDate: null status: false period: null effectiveDate: null totalRequiredAmount: null totalMinimumRequiredAmount: null paymentAmount: null totalPaymentAmount: null uwDecision: null approvalDate: null version: 1 - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.733Z featureType: lapseProtection startDate: 2023-12-27 endDate: 2043-12-26 status: null period: 20 effectiveDate: null totalRequiredAmount: null totalMinimumRequiredAmount: null paymentAmount: 51.78 totalPaymentAmount: 51.78 uwDecision: null approvalDate: null version: 1 - id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.733Z featureType: reinstatement startDate: null endDate: null status: null period: null effectiveDate: null totalRequiredAmount: null totalMinimumRequiredAmount: null paymentAmount: null totalPaymentAmount: null uwDecision: null approvalDate: null version: 1 allocation: id: null policyDetailsId: null ledgerDocId: null timestamp: 2024-01-11T12:11:40.732Z investmentType: INVESTMENTFUND modelName: null modelID: null fundAllocationsInvestments: - fundID: FundAccount1 fundName: Everly Fixed Fund UL2 fundAccountType: null allocPercent: 100 startDate: 2023-12-27 endDate: null funds: - fundAccountType: null fundID: FundAccount1 fundName: Fixed Fund glFundCode: V2201 totalFundValue: 60.759837 fundSegments: - segmentID: "1" fundID: null originalDepositAmount: 80 originalDepositDate: 2023-12-27 depositDate: 2024-11-04 depositAmount: 25 currentAmount: 60.759837 renewalDate: null numberOfUnits: null sweepAccountID: null startDate: 2023-12-27 endDate: null matchSegment: segmentID: Match1 matchAccountValue: 1.05129 cumulativeMatchPaymentAmount: 1.05 ytdMatchValue: 1.05 maxLifeTimeVestingAmount: 500 maxAnnVestingAmount: 500 minPaymentsForMatch: 0 matchVestingDate: 2034-12-26 glFundCode: V2201 vestingPeriod: 10 loanSegments: [] version: 1 version: 40 error: null failureTransactionResponse: value: status: failure validationResult: - errorCode: BPM.NM.005 attribute: null error: Amount request is invalid. resolution: Please check the One Time Premium Amount and submit the request again. - errorCode: BPM.NM.003 attribute: null error: Party information does not match with information in the Zahara system. resolution: Please validate the party information and submit the request again. securitySchemes: Auth0: type: openIdConnect openIdConnectUrl: https://login.uat.zinnia.com/.well-known/openid-configuration x-kong-security-openid-connect: config: run_on_preflight: true scopes_claim: - https://uat.api.zinnia.io/permissions audience_claim: - aud audience_required: - https://uat.api.zinnia.io client_id: - client_id auth_methods: - bearer enabled: true protocols: - grpc - grpcs - http - https ```