Skip to main content
Version: v0.0.2

Interface: X12RemitPaymentHeader

Decoded BPR - Financial Information / payment header. The PAYMENT MOVEMENT primitive: actual payment amount, credit/debit flag, method (ACH/CHK/NON/BOP/FWT), payment date. totalActualPayment is the sum the bank actually moved - Σ(claim CLP-04) + Σ(PLB adjustments) === BPR-02 is the top-level balance invariant.

Example

import type { X12RemitPaymentHeader } from "@cosyte/x12";
declare const p: X12RemitPaymentHeader;
p.totalActualPayment.toString(); // "945.00"
p.method; // "ACH"
p.paymentDate; // "20260601" (CCYYMMDD, verbatim)

Properties

creditDebitFlag

readonly creditDebitFlag: string

BPR-03 credit/debit flag. Spec-defined values: "C" (credit - money to provider, the normal case) or "D" (debit - refund / chargeback, uncommon). The field is typed as string to preserve verbatim any non-spec value from a quirky payer; consumers branching on it should compare against the literals.


method

readonly method: string


paymentDate

readonly paymentDate: string


paymentFormatCode

readonly paymentFormatCode: string | undefined


totalActualPayment

readonly totalActualPayment: X12Decimal


transactionHandlingCode

readonly transactionHandlingCode: string