github.com/moov-io/ach

BUG FIXES

• file: updated File.MergeFiles(..) to override batch numbers in each file to prevent them from colliding

IMPROVEMENTS

• file: optimized and refactored File.FlattenBatches(..) and added benchmarks
• api: added missing required fields in models in the OpenAPI spec and removed unnecessary omitempty tags for required fields in Go models
• docs: removed extra spaces in the request body for creating a file to fix broken example
• docs: added a section about where to find Nacha Operating Rules and Nacha's ACH guide for developers
• docs: updated links in README to point to project documentation site

IMPROVEMENTS

• api: update OpenAPI spec to include more details about data types
• file: ability to set custom batch sequence numbers
• docs: new project documentation site with updated styles and navigation
• docs: add page about Notification of Change (NOC) files
• docs: add read and write examples for CIE batches
• docs: update R10 and R11 return code descriptions
• docs: additional fixes and improvements to the README

BUG FIXES

• fileHeader: ImmediateDestination and ImmediateOrigin should be separated by a space unless bypass validation is set and the routing number is 10 digits

IMPROVEMENTS

• docs: improvements to README by adding a new header, table of contents, related projects, and FAQ
• docs: clarified code comments related to File.ValidateWith(..) and fixed minor documentation errors

BUG FIXES

• fileHeader: fix ImmediateDestination formatting when BypassDestinationValidation is set

ADDITIONS

• batch: allow addenda in CIE batches to be optional
• batch: allow POS batches to contain credits
• reader: allow backtick in the valid character set
• build: add tagged-release script to automate the release process

IMPROVEMENTS

• reader: report error when extra characters are found in one-line ACH files
• webui: display error when parsing fails
• deps: remove moov-io/customers and moov-io/paygate as dependencies
• docs: improvements to README by fixing typos, dead links, and formatting

BUG FIXES

• server: pass validation options through to ACH reader and underlying batch

IMPROVEMENTS

• build: push ach-webui image and split up commands for each docker build

There are no changes from v1.5.0. This release fixes issues during the release process.

ADDITIONS

• cmd/webui: initial setup for client-side ACH file parsing to their JSON forms
• entries: allow custom TransactionCode validation
• entries: allow custom TraceNumber values
• writer: allow setting Writer.LineEnding to use custom values for ending each outputted
• server: allow ValidateOpts to be set through HTTP query parameters

IMPROVEMENTS

• build: check and lint OpenAPI spec in CI
• api: update summaries of endpoints
• api: clean up OpenAPI spec after running Speccy
• docs: update content for moov-io.github.io/ach/
• docs: add page on return files
• docs: add link to Moov's ACH blog post
• docs: fix filepath example in segmented files
• github: request version in bug reports
• github: add codeowners
• chore(deps): update golang docker tag to v1.15

BUG FIXES

• server: fix batch additions by shimming JSON reading

BUG FIXES

• entries: detect overflow when printing large amounts
• reader: only parse IAT entries when we're accumulating an IAT batch

IMPROVEMENTS

• achcli: print BatchControl records as well
• achcli: update help/usage text

BUILD

• build: upload achcli binaries on each release

IMPROVEMENTS

• api: add example plaintext file for create route
• docs: flip Usage section priority, link to godocs and examples
• file: include the struct field in Unmarshal errors

BUG FIXES

• api: clarify batchNumber in BatchHeader is an integer
• api: include missing CompanyIdentification field on BatchHeader docs
• api: include missing CompanyIdentification field on BatchHeader docs
• api: quote number-looking example values

BUG FIXES

• batch: error if our offset account type is unknown

BUILD

• build: add openshift docker image
• build: enable codeql via github actions
• build: release via Actions, not TravisCI

Version v1.4.0 of ACH adds several notable features such as custom validation, a command-line tool achcli to describe files, and improvements for verifying NACHA compatibility on slightly malformed files. This release also contains enhanced testing and documentation improvements.

Custom Validation

The ACH library (and HTTP server) now supports custom validation with the ValidateOpts struct by calling File.SetValidation(..) and Reader.SetValidation(...). This offers various options:

• RequireABAOrigin bool: Enable or disable routing number validation over the ImmediateOrigin file header field
• BypassOriginValidation: Skip validation for the ImmediateOrigin file header field and allow custom TraceNumber values
• BypassDestinationValidation: Skip validation for the ImmediateDestination file header field and allow custom TraceNumber values

The HTTP server also supports reading this struct with camel-cased names when calling the validation route.

achcli

achcli is a command-line utility for viewing ACH files in a more human readable format. This tool also allows masking DFIAccountNumber values with the -mask flag.

$ achcli -mask 20200601-1002-01.ach
Describing ACH file '20200601-1002-01.ach'

  Origin     OriginName               Destination  DestinationName     FileCreationDate  FileCreationTime
  691000134  ASF APPLICATION SUPERVI  091400606    FIRST BANK & TRUST  181017            0306

  BatchNumber  SECCode  ServiceClassCode  CompanyName  CompanyDiscretionaryData  CompanyIdentification  CompanyEntryDescription
  1            WEB      200               CoinLion                               123456789              TRANSFER

    TransactionCode  RDFIIdentification  AccountNumber  Amount  Name                    TraceNumber      Category
    26               09140060            *******89      12354   Paul Jones              091000017611242  Return

      Addenda99
      ReturnCode  OriginalTrace    DateOfDeath  OriginalDFI  AddendaInformation  TraceNumber
      R01         091400600000001               09100001                         091000017611242

  BatchCount  BlockCount  EntryAddendaCount  TotalDebitAmount  TotalCreditAmount
  1           1           1                  12354             0

Malformed Files

ACH files with lines that are not 94 characters are now adjusted in-memory (missing or extra spaces) in an attempt to comply with NACHA standards. The underlying file on disk is not modified during this reading.

---

ADDITIONS

• batches: Add LiftEffectiveEntryDate() to offer parsed time.Time values of EffectiveEntryDate
• cmd/server: add version handler to admin HTTP server
• file: add BypassDestinationValidation to ValidateOpts
• file: add ValidateWith to override specific default validations
• file: support setting ValidateOpts on struct for calling Create()
• reader: morph lines to 94 characters if they end in spaces
• server: read ValidateOpts in HTTP validate route
• server: return fileID on create errors, enforce marshaled errors as strings
• file: support setting ValidateOpts on struct for calling Create()
• file: struct unmarshaling works again, it was depreciated for a couple releases
• reader: morph lines to 94 characters with spaces if they are some other length
• reader: allow setting ValidateOpts
• cmd/ach: initial setup of CLI tool to pretty print ACH files

BUG FIXES

• all: replace Ç with C across the project
• all: use filepath.Join instead of unix paths
• api: fixup flatten files OpenAPI spec
• api: note POST /files/create can return an error
• file: don't validate before flattening batches
• file: keep TraceNumbers when segmenting files
• server: fix segment OpenAPI spec and accept config body
• server: read empty SegmentFileConfiguration
• file: don't validate before flattening batches

IMPROVEMENTS

• api: used shared Error model
• api: use shorter summaries
• api: include AddendaXX, ADV, and IAT records that were missing from OpenAPI spec
• chore(deps): update module prometheus/client_golang to v1.4.1
• chore(deps): update module gorilla/mux to v1.7.4
• reader: write a test for what partial file comes back from invalid EntryDetails
• reader: allow zero-entry files if their controls signify as such
• server: use FoundABug error with mismatched routing
• validators: ensure alpha routing number check digit is invalid
• all: use filepath.Join instead of unix paths
• reader: append a lingering batch even if there's no batch control

BUILD

• chore(deps): update golang docker tag to v1.14
• build: run sonatype-nexus-community/nancy in CI
• build: leverage moov-io/infra's Go linter script

BUG FIXES

• api,client: There was a mistaken character in the OpenAPI docs Ç which should have been C.

IMPROVEMENTS

• build: upgrade golang.org/x/crypto

BUILD

• build: run sonatype-nexus-community/nancy in CI

BREAKING CHANGES

• ImmediateOrigin values are written with a leading space instead of a zero (0) due to post-2013 NACHA guidelines.

BUG FIXES

• addenda98 fix parsing with no spaces between routing and account number

ADDITIONS

• Add random names, amounts, and memo lines in test file generation script cmd/writeACH/main.go

BUG FIXES

• fileHeader: Remove requirement of ImmediateOrigin to be a routing number

ADDITIONS

• Add FlattenBatches() (*File, error) to ach.File
  • FlattenBatches minimizes File Batches by consolidating them with the same BatchHeader data into one batch.
• Add POST /files/:id/flatten which calls FlattenBatches() on a specific ACH file
• Add POST /files/:id/balance to add Offset records onto each Batch in an ACH File.
• Addenda98: Add ChangeCodeField() for detailed information about a NOC/COR change file (ChangeCode)
• Addenda99: Add ReturnCodeField() for detailed information about file returns (ReturnCode)

BUG FIXES

• reader: set EntryDetail.Category to Return when Addenda99 is present
• batch: inspect Entrydetail records for Category
• batch: check ADV entries for Category
• reader: set EntryDetail.Category to NOC when Addenda98 is present
• file: Validate files after reading them from their JSON representation
• server: actaully render new Credit and Debit files from segmentation

IMPROVEMENTS

• created example files for HTTP routes
• file: parse ISO8601 and RFC3339 timestamps in JSON blobs

BUILD

• upgrade to Go 1.13
• build: download CI tools rather than install
• build: update staticcheck with Go 1.13

BREAKING CHANGES

In our OpenAPI we've renamed fields generated as Id to ID, which is more in-line with Go's style conventions.

BUG FIXES

• fileHeader: allow immediate origin to be a 10 digit value (See: #513 by @eduardev)
• Fix JSON omitempty typo in ADVEntryDetail
• fileHeader: trim padded 0's from ImmediateOriginField() and fixup docs
• batch: only check DNE specifics if the SEC code is DNE
• files: FileHeader validate CheckRoutingNumber
• files: on empty FileCreation dates or times render today's value
• reader: return ErrFileAddendaOutsideBatch from parseAddenda when currentBatch is nil

ADDITIONS

• batch: add Equal method
• Addenda99: Add ReturnCodeField() for detailed information about a returned file
• files: support arbitrary merging of ACH files (See #529)
• entryDetail: validate that Amount is non-negative
• batch: create Debit and Credit EntryDetail offset records if needed (via WithOffset)
• addenda types: Add RuneCountInString check to Parse(record string) function
• file: create debit ach file and credit ach file from a mixed debit and credit ach file (via SegmentFile) (see #528)
• cmd/server: add environment variables to override command line flags (-http.addr and -log.format)
• file: support ADV and IAT files in (*File).SegmentFile(...)
• cmd/server: bind HTTP server with TLS if HTTPS_* variables are defined
• cmd/server: add endpoints for segmenting files into debits and credits

BUILD

• vendor: update dependencies
• Fix moov/achfuzz docker image build
• api: inline parameters to fix codegen crash
• build: push moov/ach:latest and update docs accordingly
• chore(deps): update module prometheus/client_golang to v1.1.0