Search
K
Policy Transactions

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

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
 
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

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
 
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

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
 
application/json

Transaction Eligibility

Transaction eligibility evaluation (pa-transactions-configurations)