transactionTypestring
Optional transaction type filter
Allowed values:OneTimeWithdrawalSystematicWithdrawalAssetRebalancing
Example:OneTimeWithdrawal
Get PPFA Reference Data by Policy
Fetches PPFA integrated reference data filtered by policy. Includes VI restriction filtering for transaction subtypes and disbursement types.
get
Query Parameters
Path Parameters
planCodestringrequired
Plan code
Example:534222609
policyNumberstringrequired
Policy number
Example:959343323
Response
application/json
Response
application/json
Successful response
idstring
Unique identifier
Example:678f1a2b3c4d5e6f7890abcd
planNamestring
Name of the plan
Example:Variable Annuity Premier Growth Plan
policyProductTypeobject
Generic code/displayName object
Show Child Parameters
featureMappingobject
Generic code/displayName object
Show Child Parameters
featureCodestring
Feature code
Example:PARTIAL_WD_001
arrangementTypeobject
Generic code/displayName object
Show Child Parameters
arrangementSubTypeobject
Generic code/displayName object
Show Child Parameters
transactionTypearray[object]
Generic code/displayName object
Show Child Parameters
transactionSubtypesarray[object]
Complete transaction subtype with all arrangement and fund details, enriched with VI 21209 real-time amounts
Show Child Parameters
paymentModeobject
Generic code/displayName object
Show Child Parameters
paymentMethodarray[object]
Generic code/displayName object
Show Child Parameters
fundDisbursementTypearray[object]
Generic code/displayName object
Show Child Parameters
disbursementTypesarray[string]
Applicable disbursement types from VI
Example:Gross, Net
sourceTransferAmtTypearray[object]
Generic code/displayName object
Show Child Parameters
amountQualifierarray[object]
Generic code/displayName object
Show Child Parameters
taxRateBasedOnobject
Generic code/displayName object
Show Child Parameters
taxWithholdingCollectobject
Generic code/displayName object
Show Child Parameters
taxWithholdingPlaceobject
Generic code/displayName object
Show Child Parameters
withholdStateIfFederalIndobject
Generic code/displayName object
Show Child Parameters
taxJurisdictionobject
Generic code/displayName object
Show Child Parameters
taxMinPercentagestring
Minimum tax percentage
Example:0
taxMaxPercentagestring
Maximum tax percentage
Example:100
taxTransferAmtTypestring
Tax transfer amount type
Example:PERCENT
jurisdictionobject
Generic code/displayName object
Show Child Parameters
effectiveDateDurationobject
Effective date duration with min/max values in days
Show Child Parameters
featureMaxNumInstancesnumber
Maximum feature instances
Example:12
minContractAmtnumber
Minimum contract amount
Example:1000
maxNumSourceInvestProdnumber
Maximum source investment products
Example:10
minNumSourceInvestmentsnumber
Minimum source investments
Example:1
featureProductCodeobject
Generic code/displayName object
Show Child Parameters
featureProductInfoarray[object]
Feature product information
actionTypeAllowedarray[object]
Generic code/displayName object
Show Child Parameters
planCodestring
Plan code
Example:534222609
viAmountsobject
VI-derived amount values for withdrawal rule evaluation.
Contains real-time policy values from VI 21209 response.
Show Child Parameters
viFundsarray[object]
VI-derived fund information with withdrawal eligibility
Show Child Parameters
get/policy/v1/transactions/{planCode}/{policyNumber}/refdata
Authentication
Path Parameters
Query Parameters
application/json
Transactions Reference Data
MongoDB-backed transaction reference data (pa-transactions-configurations)
Get DTCC participants
Returns currently effective DTCC participant records wrapped in a standard
reference envelope { "referenceType": "dtcc-participants", "results": [...] }.
All query parameters are optional and combined with AND logic when supplied.
Valid filter combinations: participantId alone, companyId alone,
companyId + planCode, or any combination of the three.
Expired and future-dated records are automatically excluded.
get
Query Parameters
companyIdstring
Filter by company identifier (exact, case-sensitive). Blank treated as absent.
Example:ABC
planCodestring
Filter by plan code (exact, case-sensitive). Blank treated as absent.
Example:ANN100
participantIdstring
Filter by participant identifier (exact, case-sensitive). May be used alone or combined with companyId/planCode. Blank treated as absent.
Example:PART001
Response
application/json
Response
application/json
Wrapped list of matching effective DTCC participant records. results is empty when no records match.
DtccParticipantReferenceResponse
Wrapped response envelope for the dtcc-participants reference endpoint.
referenceTypestringrequired
Example:dtcc-participants
resultsarray[object]required
A single DTCC participant record. Only currently effective records are returned.
Show Child Parameters
get/policy/v1/transactions/references/dtcc-participants
Authentication
Query Parameters
application/json
Get product transactions
Returns currently effective product transaction records wrapped in a standard
reference envelope { "referenceType": "product-transactions", "results": [...] }.
All query parameters are optional and combined with AND logic when supplied.
Expired and future-dated records are automatically excluded.
get
Query Parameters
clientCodestring
Filter by rule-engine client code (exact, case-sensitive). Blank treated as absent.
Example:OTP_BPM
planCodestring
Filter by plan code (exact, case-sensitive). Blank treated as absent.
Example:ANN100
Response
application/json
Response
application/json
Wrapped list of matching effective product transaction records. results is empty when no records match.
ProductTransactionReferenceResponse
Wrapped response envelope for the product-transactions reference endpoint.
referenceTypestringrequired
Example:product-transactions
resultsarray[object]required
A single product transaction record. Only currently effective records are returned.
Show Child Parameters
get/policy/v1/transactions/references/product-transactions
Authentication
Query Parameters
application/json
Get restriction types
Returns currently effective restriction type records wrapped in a standard
reference envelope { "referenceType": "restriction-list", "results": [...] }.
The restrictionSubTypes array is always present — empty [] when no sub-types
exist, never null. A null description is preserved as null.
Expired and future-dated records are automatically excluded.
get
Query Parameters
restrictionTypestring
Filter by restriction type code (exact, case-sensitive). Blank treated as absent.
Example:OVERPAYMENT
Response
application/json
Response
application/json
Wrapped list of matching effective restriction type records. results is empty when no records match.
RestrictionTypeReferenceResponse
Wrapped response envelope for the restriction-list reference endpoint.
referenceTypestringrequired
Example:restriction-list
resultsarray[object]required
A single restriction type record. restrictionSubTypes is always present (empty array when none exist, never null). description may be null.
Show Child Parameters
get/policy/v1/transactions/references/restriction-list
Authentication
Query Parameters
application/json