| Purpose | Getting Started | Configuration |
We’ve designed and released achgateway for orchestrating ACH uploads in real production scenarios. Please read over our guide to achgateway and give us feedback on the design or your experience! We appreciate your trust and support to build these low-level payment protocols and utilities.
Moov Paygate is a RESTful API enabling Automated Clearing House (ACH) transactions to be submitted and received without a deep understanding of a full NACHA file specification.
Sending payments with PayGate currently relies on a “good funds” model where funds are available prior to sending them out in terms of ACH credits. This funding model implies that only a subset of payment product flows are supported, but PayGate offers flexibility to support additional payment products.
Running PayGate
Dependencies
Production Checklist
Extending PayGate
Below is a summary of the major components within PayGate that coordinate for ACH origination and processing.
PayGate stores data in SQLite or MySQL given the configuration provided to track Transfers, Micro-Deposits, and other information. This is done so PayGate can be restarted or replication setup to run in an production environment.
See the database configuration section for more information.
Before money can be transferred in the United States a few conditions must be verified by PayGate according to consumer protection, fraud detection, and foreign policy actions. These regulations are outside of Moov or PayGate but must be followed by all users of the US payment methods.
To accomplish this PayGate relies on Moov Customers for tracking sensitive consumer/business information, Moov Fed for ABA routing number lookup, and Moov Watchman for current sanctions policy restrictions.
Micro-Deposits can only be initiated for a Customer with status ReceiveOnly or Verified and an Account in the None status.
See the customer configuration section for more information.
Transfers can only be created if they contain valid fields, an appropriate source and destination, and configuration for your ODFI. Even if they’re valid Transfers might be rejected prior to upload after being received by the other Financial Institution. After Transfer objects are created in PayGate they are pushed into a pipeline to be processed through a variety of operations to transform, merge, optimize and possibly encrypt them prior to upload to the ODFI.
The pipeline consists of several steps: audit recording, merging into ACH files, and entry/file balancing. These steps are all optional and by default PayGate will merge Transfers into as few ACH files as possible without balancing. See the transfer pipeline configuration section for more information.
PayGate is configured with cutoff windows which are timestamps to flush pending inbound and outbound files with the ODFI. There are typically several cutoff windows every banking day and are used to have payments complete faster. The Federal Reserve and financial institutions all across the US are working to increase the number of cutoff windows each banking day.
Uploading of ACH files consists of a couple steps: encryption, output formatting, and notifications on success or failure. These are all optional and ACH files will be uploaded in their clear-text NACHA format by default. See the ODFI configuration section for more information.
PayGate interacts with FTP and SFTP (SSH File Transport Protocol) to upload and download files from an ODFI’s server. Both protocols can leverage current industry standards for encryption and security.
| channel | info |
|---|---|
| Project Documentation | Our project documentation available online. |
| Twitter @moov | 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 a problem please open a GitHub Issue under the specific project that caused the error. |
| moov-io slack | Join our slack channel (#paygate) to have an interactive discussion about the development of the project. |