Package 'moov-io/ach' implements a file reader and writer for parsing ACH Automated Clearing House files. ACH is the primary method of electronic money movement throughout the United States.
ACH is under active development but already in production for multiple companies. Please star the project if you are interested in its progress.
- Library currently supports the reading and writing
- ARC (Accounts Receivable Entry)
- BOC (Back Office Conversion)
- CCD (Corporate credit or debit)
- CIE (Customer-Initiated Entry)
- COR (Automated Notification of Change(NOC))
- POP (Point of Purchase)
- POS (Point of Sale)
- PPD (Prearranged payment and deposits)
- RCK (Represented Check Entries)
- SHR (Shared Network Entry)
- TEL (Telephone-Initiated Entry)
- WEB (Internet-initiated Entries)
- Return Entries
- Addenda Type Code 02
- Addenda Type Code 05
- Addenda Type Code 98
- Addenda Type Code 99
- Additional SEC codes will be added based on library users needs. Please open an issue with a valid test file.
- Review the project issues for more detailed information
The following is a high level of reading and writing an ach file. Tests exist in projects test folder with more details.
// open a file for reading or pass any io.Reader NewReader()
f, err := os.Open("name-of-your-ach-file.ach")
if err != nil {
log.Panicf("Can not open local file: %s: \n", err)
}
r := ach.NewReader(f)
achFile, err := r.Read()
if err != nil {
fmt.Printf("Issue reading file: %+v \n", err)
}
// ensure we have a validated file structure
if achFile.Validate(); err != nil {
fmt.Printf("Could not validate entire read file: %v", err)
}
// Check if any Notifications Of Change exist in the file
if len(achFile.NotificationOfChange) > 0 {
for _, batch := range achFile.NotificationOfChange {
a98 := batch.GetEntries()[0].Addendum[0].(*Addenda98)
println(a98.CorrectedData)
}
}
// Check if any Return Entries exist in the file
if len(achFile.ReturnEntries) > 0 {
for _, batch := range achFile.ReturnEntries {
aReturn := batch.GetEntries()[0].Addendum[0].(*Addenda99)
println(aReturn.ReturnCode)
}
}
The following is based on simple file creation
fh := ach.NewFileHeader()
fh.ImmediateDestination = "9876543210" // A blank space followed by your ODFI's transit/routing number
fh.ImmediateOrigin = "1234567890" // Organization or Company FED ID usually 1 and FEIN/SSN. Assigned by your ODFI
fh.FileCreationDate = time.Now() // Todays Date
fh.ImmediateDestinationName = "Federal Reserve Bank"
fh.ImmediateOriginName = "My Bank Name")
file := ach.NewFile()
file.SetHeader(fh)
Explicitly create a PPD batch file.
Errors only if payment type is not supported
func mockBatchPPDHeader() *BatchHeader {
bh := NewBatchHeader()
bh.ServiceClassCode = 220
bh.StandardEntryClassCode = "PPD"
bh.CompanyName = "ACME Corporation"
bh.CompanyIdentification = "123456789"
bh.CompanyEntryDescription = "PAYROLL"
bh.EffectiveEntryDate = time.Now()
bh.ODFIIdentification = "6200001"
return bh
}
mockBatch := NewBatch(mockBatchPPDHeader())
OR use the NewBatch factory
func mockBatchPPDHeader() *BatchHeader {
bh := NewBatchHeader()
bh.ServiceClassCode = 220
bh.StandardEntryClassCode = "PPD"
bh.CompanyName = "ACME Corporation"
bh.CompanyIdentification = "123456789"
bh.CompanyEntryDescription = "PAYROLL"
bh.EffectiveEntryDate = time.Now()
bh.ODFIIdentification = "6200001"
return bh
}
mockBatch, _ := ach.NewBatch(mockBatchPPDHeader())
To create an entry
entry := ach.NewEntryDetail()
entry.TransactionCode = 22
entry.SetRDFI("009101298")
entry.DFIAccountNumber = "123456789"
entry.Amount = 100000000
entry.IndividualName = "Wade Arnold"
entry.SetTraceNumber(bh.ODFIIdentification, 1)
entry.IdentificationNumber = "ABC##jvkdjfuiwn"
entry.Category = ach.CategoryForward
To add one or more optional addenda records for an entry
addenda := NewAddenda05()
addenda.PaymentRelatedInformation = "Bonus pay for amazing work on #OSS"
Add the addenda record to the detail entry
entry.AddAddenda(addenda)
Entries are added to batches like so:
batch.AddEntry(entry)
When all of the Entries are added to the batch we can create the batch.
if err := batch.Create(); err != nil {
fmt.Printf("%T: %s", err, err)
}
And batches are added to files much the same way:
file.AddBatch(batch)
Now add a new batch for accepting payments on the WEB
func mockBatchWEBHeader() *BatchHeader {
bh := NewBatchHeader()
bh.ServiceClassCode = 220
bh.StandardEntryClassCode = "WEB"
bh.CompanyName = "Your Company, inc"
bh.CompanyIdentification = "123456789"
bh.CompanyEntryDescription = "Online Order"
bh.ODFIIdentification = "6200001"
return bh
}
batch2, _ := ach.NewBatch(mockBatchWEBHeader())
Add an entry and define if it is a single or reoccurring payment. The following is a reoccurring payment for $7.99
entry2 := ach.NewEntryDetail()
entry2.TransactionCode = 22
entry2.SetRDFI(102001017)
entry2.DFIAccountNumber = "5343121"
entry2.Amount = 799
entry2.IndividualName = "Wade Arnold"
entry2.SetTraceNumber(bh.ODFIIdentification, 1)
entry2.IdentificationNumber = "#123456"
entry.DiscretionaryData = "R"
entry2.Category = ach.CategoryForward
addenda2 := NewAddenda05()
addenda2.PaymentRelatedInformation = "Monthly Membership Subscription"
Add the entry to the batch
entry2.AddAddenda(addenda2)
Create and add the second batch
batch2.AddEntry(entry2)
if err := batch2.Create(); err != nil {
fmt.Printf("%T: %s", err, err)
}
file.AddBatch(batch2)
Once we added all our batches we must build the file
if err := file.Create(); err != nil {
fmt.Printf("%T: %s", err, err)
}
Finally we want to write the file to an io.Writer
w := ach.NewWriter(os.Stdout)
if err := w.Write(file); err != nil {
fmt.Printf("%T: %s", err, err)
}
w.Flush()
}
Which will generate a well formed ACH flat file.
101 210000890 1234567891708290000A094101Your Bank Your Company #00000A1
5200Your Company 123456789 PPDTrans. DesOct 23010101 1234567890000001
6271020010175343121 0000017500#456789 Bob Smith B11234567890000001
705bonus pay for amazing work on #OSS 00010000001
82000000020010200101000000017500000000000000123456789 234567890000001
5220Your Company 123456789 WEBsubscr Oct 23010101 1234567890000002
6221020010175343121 0000000799#123456 Wade Arnold R 1234567890000001
705Monthly Membership Subscription 00010000001
82200000020010200101000000000000000000000799123456789 234567890000002
9000002000001000000040020400202000000017500000000000799
| channel | info |
|---|---|
| Google Group moov-users | The Moov users Google group is for contributors other people contributing to the Moov project. You can join them without a google account by sending an email to moov-users+subscribe@googlegroups.com. After receiving the join-request message, you can simply reply to that to confirm the subscription. |
| Twitter @moov_io | You can follow Moov.IO's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories. |
| GitHub Issue | If you are able to reproduce an problem please open a GitHub Issue under the specific project that caused the error. |
| moov-io slack | Join our slack channel to have an interactive discussion about the development of the project. |
Yes please! Please review our Contributing guide and Code of Conduct to get started!
Apache License 2.0 See LICENSE for details.
