Search
K
Policy Transactions

DtccParticipantRecord

object

A single DTCC participant record. Only currently effective records are returned.

companyIdstring

Example:ABC

planCodestring

Example:ANN100

participantIdstring

Participant identifier.

Example:PART001

typestring

Participant type code (e.g. “B” = broker-dealer, “C” = custodian).

Example:B

participantDescstring

Example:ABC Participant

restrictPlanCodestring
participantEndDatestring(date)

Business end date (ISO 8601). Distinct from expirationDate.

effectiveDatestring(date)

Record validity start (ISO 8601, inclusive).

Example:2025-01-01

expirationDatestring(date)

Record validity end (ISO 8601, inclusive). null means no expiry.

Example

ProductTransactionReferenceResponse

object

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
Example

ProductTransactionRecord

object

A single product transaction record. Only currently effective records are returned.

clientCodestring

Rule-engine client code.

Example:OTP_BPM

planCodestring

Example:ANN100

transactionstring

Transaction type identifier.

Example:FullWithdrawal

transactionDescstring

Example:Full Withdrawal

effectiveDatestring(date)

Record validity start (ISO 8601, inclusive).

Example:2025-01-01

expirationDatestring(date)

Record validity end (ISO 8601, inclusive). null means no expiry.

Example

RestrictionTypeReferenceResponse

object

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
Example

RestrictionTypeRecord

object

A single restriction type record. restrictionSubTypes is always present (empty array when none exist, never null). description may be null.

restrictionTypestringrequired

Restriction type code.

Example:OVERPAYMENT

labelstringrequired

Human-readable short label.

Example:Overpayment

restrictionSubTypesarray[object]required

An individual sub-type within a restriction type.

Show Child Parameters
descriptionstring

Example:This alert restricts certain transactions on a policy.

effectiveDatestring(date)required

Record validity start (ISO 8601, inclusive).

Example:2025-01-01

expirationDatestring(date)

Record validity end (ISO 8601, inclusive). null means no expiry.

Example