Skip to main content
Version: v0.0.3

Interface: TelecomTransaction

A decoded Telecom transmission: the fixed header, the variable segments of the first transaction (field-id-keyed, in wire order), the header's declared transaction count, and any non-fatal warnings. Everything is frozen.

Properties

readonly header: TelecomHeader

The decoded fixed Transaction Header. For a response, the overlapping fields (version, transaction code, count, service provider) are lifted from the response header; request-only fields (BIN, PCN, …) are empty.


kind

readonly kind: "request" | "response"

Whether this is a request transmission (decoded against the 56-byte request header) or a response transmission (decoded against the response header).


profile?

readonly optional profile?: NcpdpProfile

The trading-partner profile in effect for this parse: either passed explicitly via options.profile or resolved from the process-scoped default. Present only when a profile applied; attribution only (v1 profiles never alter the parse).


responseHeader?

readonly optional responseHeader?: TelecomResponseHeader

The decoded Response Transaction Header: present only when kind is "response".


segments

readonly segments: readonly TelecomSegment[]

The first transaction's segments, in wire order.


transactionCount

readonly transactionCount: string

Declared number of transactions (109-A9), verbatim from the header.


warnings

readonly warnings: readonly NcpdpTelecomWarning[]

Non-fatal parse warnings: stable code + byte offset + field id, never PHI.