Interface: Build820PaymentSpec

BPR financial-information / payment header. totalPremiumAmount is the aggregate premium the bank moved (BPR-02). Identical segment shape to the 835 - but the 820 carries no balance equation, so this total is emitted verbatim, never reconciled against the remittance open items.

Example

import type { Build820PaymentSpec } from "@cosyte/x12";
import { X12Decimal } from "@cosyte/x12";
const bpr: Build820PaymentSpec = {
  transactionHandlingCode: "I",
  totalPremiumAmount: X12Decimal.fromString("12500.00")!,
  creditDebitFlag: "C", method: "ACH", paymentDate: "20260601",
};

Properties

creditDebitFlag

readonly creditDebitFlag: string

BPR-03 - credit/debit flag (C credit, D debit).

---

method

readonly method: string

BPR-04 - payment method (ACH, CHK, NON, …).

---

paymentDate

readonly paymentDate: string

BPR-16 - payment effective date (CCYYMMDD).

---

paymentFormatCode?

readonly optional paymentFormatCode?: string

BPR-05 - payment format code (situational).

---

totalPremiumAmount

readonly totalPremiumAmount: X12Decimal

BPR-02 - total premium amount the bank moved.

---

transactionHandlingCode

readonly transactionHandlingCode: string

BPR-01 - transaction handling code (I remittance + payment, H notification, …).