Assumptions
These are the assumptions for the examples.
- The achpri01_validate example map processes an ACH file with 20 batch records. The example map goes through each batch record. Depending upon the Standard Entry Class (SEC) codes, the example map verifies the format of the Payment Related Information field on the Addenda Record.
- For ACH Payment Acknowledgement (ACK) and Financial EDI Acknowledgment (ATX) entries, the Payment Related Information field must contain an ANSI version release 5010 ASC X12 REF (Reference) data segment.
- For Corporate Credit or Debit Entry (CCD) entries, Payment Related Information field must contain an ANSI ASC X12 data segment, or NACHA endorsed banking conventions (that is Tax Payment, Third-Party Tax Payments, or Child Support).
- For Corporate Credit or Debit Entry (CCD) entries that are used for Healthcare EFT transactions, the Company Entry Description field on the Batch Record has a value that is set to HCCLAIMPMT. Also, the Payment Related Information field must contain an ANSI version release 5010 ASC X12 TRN (Re-association Trace Number) data segment.
- For Corporate Credit or Debit Entry (CCD) entries that are used for Tax Payment, the Payment Related Information field must contain a variant of the ANSI version release 3060 ASC X12 TXP (Tax Payment) data segment. For more information, see the NACHA endorsed, Tax Payment (TXP) Banking Convention implementation guide. This implementation guide is available at the following website: https://www.nacha.org/bankingconvention
- For Corporate Credit or Debit Entry (CCD) entries that are used for Third-Party Tax Payment, the Payment Related Information field must contain an ASC X12 TPP (Third-Party Tax Payment) data segment. For more information, see the NACHA endorsed, Third-Party Tax Payment (TPP) Banking Convention implementation guide. This implementation guide is available on the following website: https://www.nacha.org/bankingconvention
- For Corporate Credit or Debit Entry (CCD) entries that are used for Child Support, the Payment Related Information field must contain a variant of ANSI version release 4010 ASC X12 DED (Child Support) data segment. For more information, see the NACHA endorsed, Child Support (DED) Banking Convention implementation guide. This implementation guide is available on the following website: https://www.nacha.org/bankingconvention
- For Customer Initiated Entry (CIE), Pre-arranged Payment and Deposit Entries (PPD), Internet-Initiated/Mobile Entries (WEB debit entries), the Payment Related Information field must contain ANSI ASC X12 data segments.
- For Internet-Initiated/Mobile Entries (WEB credit entries), the Payment Related Information field content does not have any formatting requirements.
- For Death Notification Entries (DNE) entries, the Payment Related
Information field must contain one of either of the following two NACHA endorsed banking
conventions.
- DATE OF DEATH*MMDDYY*CUSTOMERSSN*#########*AMOUNT*$$$$.cc\
- DATE OF DEATH*MMDDYY*CUSTOMERSSN*#########*AMOUNT*$$$$.cc~
- In Automated Enrollment Entry (ENR) entries, the Payment Related
Information field must contain one of either of the following two NACHA endorsed banking
conventions.
- TRANSACTION CODE (2 CHARS)*RECEIVING DFI IDENTIFICATION NUMBER (8 CHARS)*CHECK DIGIT (1 CHAR)*DFI ACCOUNT NUMBER (MAX 17 CHARS)*INDIVIDUAL ID NUMBER OR ID NUMBER (9 CHARS)*INDIVIDUAL SURNAME OR COMPANY NAME(MAX 15 CHARS)*INDIVIDUAL FIRST NAME OR COMPANY NAME(MAX 7 CHAR)*REPRESENTATIVE PAYEE INDICATOR/ENROLLEE CLASSIFICATION CODE(1 CHAR)\
- TRANSACTION CODE (2 CHARS)*RECEIVING DFI IDENTIFICATION NUMBER (8 CHARS)*CHECK DIGIT (1 CHAR)*DFI ACCOUNT NUMBER (MAX 17 CHARS)*INDIVIDUAL ID NUMBER OR ID NUMBER (9 CHARS)*INDIVIDUAL SURNAME OR COMPANY NAME(MAX 15 CHARS)*INDIVIDUAL FIRST NAME OR COMPANY NAME(MAX 7 CHAR)*REPRESENTATIVE PAYEE INDICATOR/ENROLLEE CLASSIFICATION CODE(1 CHAR)~
- For International ACH Entry (IAT) entries with the Transaction Type Code
field within the First IAT Addenda Record. If this field contains ARC,
BOC, or RCK, the Payment Related
Information field must contain either of the following NACHA endorsed banking conventions:
- CHECK SERIAL NUMBER\
- CHECK SERIAL NUMBER~
- For International ACH Entry (IAT) entries with the Transaction Type Code
field within the First IAT Addenda Record. If this field contains POP, the
Payment Related Information field must contain one of either of the following
two NACHA endorsed banking conventions.
- CHECK SERIAL NUMBER (MAX 9 CHARS)*TERMINAL CITY (MAX 4 CHARS)*TERMINAL STATE/FOREIGN COUNTRY (2 CHARS)\
- CHECK SERIAL NUMBER (MAX 9 CHARS)*TERMINAL CITY (MAX 4 CHARS)*TERMINAL STATE/FOREIGN COUNTRY (2 CHARS)~
- For International ACH Entry (IAT) entries with the Transaction Type Code
field within the First IAT Addenda Record. If this field contains MTE,
POS, or SHR, the Payment Related
Information field must contain one of the following two NACHA endorsed banking conventions.
- TERMINAL IDENTIFICATION CODE(MAX 6 CHARS)*TERMINAL LOCATION (MAX 27 CHARS)*TERMINAL CITY (MAX 15 CHARS)*TERMINAL STATE or FOREIGN COUNTRY (2 CHARS)\
- TERMINAL IDENTIFICATION CODE(MAX 6 CHARS)*TERMINAL LOCATION (MAX 27 CHARS)*TERMINAL CITY (MAX 15 CHARS)*TERMINAL STATE or FOREIGN COUNTRY (2 CHARS)~
- The example map supports only the following SEC codes, ACK, ATX, CCD, CIE, PPD, DNE, ENR, IAT, and WEB entries.
- The example map requires an input ACH file that passes the ACH 2016 type tree validation.
- The achpri01_validate example map generates an XML output document that
consists of the following information about the ACH file.
- File record information
- Immediate Origin
- Immediate Origin Name
- File Creation Date
- File Creation Time
- File ID Modifier
- File Entry / Addenda Count
- File Total Debit Entry Dollar Amount
- File Total Credit Entry Dollar Amount
- File Batch Count
- File Date / Time Processed
- Batch record information
- Batch Number
- Originating DFI Id
- Company Name
- Company Id
- Effective Entry Data
- Batch Entry/Addenda Count
- Batch Total Debit Entry Dollar Amount
- Batch Total Credit entry Dollar Amount
- Entry detail record information
- Receiving DFI ID
- Receiving Company Name/Id Number
- Trace Number
- ACH (SEC) Entry Code
- ACH (SEC) Entry Is Supported Flag (true or false)
- Addenda Record Information
- Entry Detail Sequence Number
- Addenda Sequence Number
- Payment Related Information (PRI)
- PRI Validation Information
- Reason of Failure
- Status (PASS or FAIL)
- Out of the 20 batch records contained in the input ACH file
(ach_pri_example.in), the example map detects two batch records with a
Payment Related Information field that is not compliant with NACHA endorsed
banking conventions. The two batch records are listed here:
- Batch Number: 4444442, due to a missing TRN data segment on the Payment Related Information field on a Healthcare EFT CCD entry.
- Batch Number: 4444445, due to a mismatch between the value that is set on the amount field of the Entry Detail Record and the TPP04 amount data element on the Payment Related Information field.
- File record information