ProductTransactionRecord
objectA single product transaction record. Only currently effective records are returned.
Rule-engine client code.
Example:OTP_BPM
Example:ANN100
Transaction type identifier.
Example:FullWithdrawal
Example:Full Withdrawal
Record validity start (ISO 8601, inclusive).
Example:2025-01-01
Record validity end (ISO 8601, inclusive). null means no expiry.
RestrictionTypeReferenceResponse
objectWrapped response envelope for the restriction-list reference endpoint.
Example:restriction-list
A single restriction type record. restrictionSubTypes is always present (empty array when none exist, never null). description may be null.
Show Child Parameters
RestrictionTypeRecord
objectA single restriction type record. restrictionSubTypes is always present (empty array when none exist, never null). description may be null.
Restriction type code.
Example:OVERPAYMENT
Human-readable short label.
Example:Overpayment
An individual sub-type within a restriction type.
Show Child Parameters
Example:This alert restricts certain transactions on a policy.
Record validity start (ISO 8601, inclusive).
Example:2025-01-01
Record validity end (ISO 8601, inclusive). null means no expiry.
RestrictionSubTypeRecord
objectAn individual sub-type within a restriction type.
Sub-type identifier/label.
Example:No info released
Example:This policy/contract is under a legal hold.
TransactionAttributesResponse
objectResponse for GET /policy/v1/transactions/{planCode}/{policyNumber}/transaction-attributes/{transactionType}. Always returns HTTP 200. Check found to determine whether configuration exists. Attributes are merged from ref-transaction-attributes (plan-specific) and ref-transaction-attributes-default (client-level defaults); specific takes precedence on collision.
true when at least one collection returned a record and attributes were resolved; false otherwise.
Example:true
Human-readable explanation when found is false. Absent when found is true.
Example:No attribute configuration found for transactionType=Nonforfeiture, clientCode=GILI, planCode=GCFIA901
Carrier code derived from the policy. Null when the policy could not be fetched.
Example:GILI
Plan code from the request path.
Example:GCFIA901
Policy number from the request path.
Example:9013055733
Transaction type from the request path.
Example:OneTimeWithdrawal
A single resolved attribute entry. Always contains only the final resolved value — override configuration is never included in the response.