IriTransactionExternalIdentifiers
objectCarrier payment reference number.
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:EXT-REF-1001
Carrier-side transaction identifier.
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:EXT-TX-1001
Carrier-side systematic program (arrangement) identifier.
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:ARR-001
IriPolicyTransaction
objectUnique identifier assigned to the transaction.
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:TX-1001
The unique identifier of the reversed transaction. When a transaction is reversed, this field holds the ID of the original transaction that was reversed. We capture this to ensure proper tracking and auditing of financial adjustments within the system
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:TX-REF-0000
Unique identifier for the impacted party data being updated with a transaction or event. For example, if multiple addresses are modified, this field identifies the specific address Id for which change is being processed
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:PAR-686
Trigger to Pass in API which non financial was newly added out of multiple change requests, for example a new email was added
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:PAR-908
The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration
Match pattern:^[A-Za-z0-9._-]{1,50}$
Example:FIAPRM01
The unique identifier of a Parent Transaction or Parent Program ID. The value of parentId varies based on the transaction type. >>For Subsequent Premium, One-Time Premium, Loan Repayment (One-Time & Systematic) → The Parent Payment Transaction ID is stamped. >> For Forceout and Disbursement → The Parent Money Out or Money In Transaction ID is stamped
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:ROOT-1
Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc
Allowed values:SubsequentPaymentOneTimePremiumPartialWithdrawalOneTimeSystematicPartialWithdrawalRequiredMinimumDistributionOneTimeSystematicRequiredMinimumDistributionFullSurrenderFundTransferFundAllocationsChangeSweepDollarCostAverageNewLoanLoanRepaymentOneTimeSystematicLoanRepaymentAnnuitizationSystematicAnnuityPayoutPayoutAmountChangeServiceChargeRiderChargeValueAdjustmentInterestCreditAddressChangeEmailChangePhoneNumberChangeBeneficiaryChangeOwnerChangeBankAccountChangeCommunicationPreferenceChangeReinstatementLapseOther
The date when the transaction request was initiated or received in the system. For example, for system generated events date on which transaction was initiated by the system for adhoc events date on which transaction was received by the system.
Example:2026-03-06
Represents the date on which the policy or contract became active and coverage officially began.
Example:2026-03-06
Represents the date when the transaction is processed by the system.
Example:2026-03-06
The date when a transaction is reversed in the system
Example:9999-12-31
A Feature Status in life insurance and annuities indicates the current state or activation condition of a specific feature within a policy or contract. It reflects whether a feature is active, inactive, pending, or restricted, helping insurers, agents, and policyholders track policy functionality
Allowed values:PendingCompletedFailedReversedCanceledPendingReversal
The justification or business reason for the transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS
Details of financial amounts associated with the transaction
Show Child Parameters
Charges applied as part of the transaction.
Show Child Parameters
Tax withholding instructions associated with the transaction.
Show Child Parameters
Create or update timestamp of the transaction event.
Example:2026-03-06T12:00:00Z
Whether the transaction was initiated as a reversal (reverse-and-reprocess).
Version number of the policy after the transaction.
Example:1
External identifiers associated with the transaction.
Show Child Parameters
IriPolicyTransactions
objectUsed for pagination to indicate where the returned page starts within the full result set.
>= 0
Number of records included in the current response page.
>= 0
Example:1
Total number of records available that match the request criteria, independent of pagination.
>= 0
Example:1
Transactions associated with the policy.