paygate

README

moov-io/paygate

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.

Docs: Project | API Endpoints | Admin API Endpoints

This project is sponsored by Moov Financial, Inc which offers commercial support, hosting, and additional features. Refer to our product documentation for more information.

Project Status

This project is currently under development and could introduce breaking changes to reach a stable status. We are looking for community feedback so please try out our code or give us feedback!

Getting Started

Paygate can be ran or deployed in various ways. We have several guides for running paygate and offer a testing utility called apitest from the moov-io/api repository for verifying paygate (and its dependnecies) are running properly.

• Using docker-compose
• Using our Docker image
• Build from source
• How to setup open source ACH payments using Moov.io suite by Taylor Gunnoe
  • Taylor has also written paygate-cli which is a command-line interface to paygate.

Deployment

Paygate currently requires an instance of Moov Customers to be running and the address to its HTTP server set in PayGate's config file.

Note: The X-User-Id (case insensntive) HTTP header is also required and we recommend using an auth proxy to set this. Paygate only expects this value to be unique and consistent to a user.

Docker image

You can download our docker image moov/paygate from Docker Hub or use this repository. No configuration is required to serve on :8082 and metrics at :9092/metrics in Prometheus format.

$ docker run -p 8082:8082 moov/paygate:latest
ts=2020-06-29T21:57:08.427368Z caller=main.go:243 startup="Starting paygate server version v0.8.0"
level=info ts=2020-06-29T21:57:08.428856Z caller=logger.go:63 msg="Initializing logging reporter\n"
ts=2020-06-29T21:57:08.429215Z caller=database.go:25 database="setting up sqlite database provider"
ts=2020-06-29T21:57:08.429252Z caller=sqlite.go:97 main="sqlite version 3.31.1"
ts=2020-06-29T21:57:08.43175Z caller=main.go:87 admin="listening on [::]:9092"
ts=2020-06-29T21:57:08.433259Z caller=main.go:134 main="registered America/New_York cutoffs=16:20"
ts=2020-06-29T21:57:08.43329Z caller=aggregate.go:72 aggregate="setup *audittrail.MockStorage audit storage"
ts=2020-06-29T21:57:08.433309Z caller=aggregate.go:78 aggregate="setup []transform.PreUpload(nil) pre-upload transformers"
ts=2020-06-29T21:57:08.433317Z caller=aggregate.go:84 aggregate="setup *output.NACHA output formatter"
ts=2020-06-29T21:57:08.433379Z caller=client.go:186 customers="using http://localhost:8087 for Customers address"
ts=2020-06-29T21:57:08.433623Z caller=scheduler.go:44 inbound="starting inbound processor with interval=10m0s"
ts=2020-06-29T21:57:08.433635Z caller=main.go:207 startup="binding to :8082 for HTTP server"

Local development

We support a Docker Compose environment in paygate that can be used to launch the entire Moov stack. Using the source code of the latest released docker-compose.yml is recommended.

$ docker-compose up -d
paygate_ach_1 is up-to-date
paygate_ofac_1 is up-to-date
Recreating paygate_accounts_1 ...
paygate_fed_1 is up-to-date
Recreating paygate_accounts_1 ... done
Recreating paygate_paygate_1  ... done

Build from source

PayGate orchestrates several services that depend on Docker and additional GoLang libraries to run. Paygate leverages Go Modules to manage dependencies. Ensure that your build environment is running Go 1.14 or greater. PayGate depends on other Docker containers that will be downloaded for testing and running the service. Ensure Docker is installed and running.

$ cd moov/paygate # wherever this project lives

$ go run ./cmd/server/
ts=2020-06-29T21:57:08.427368Z caller=main.go:243 startup="Starting paygate server version v0.8.0-dev"
level=info ts=2020-06-29T21:57:08.428856Z caller=logger.go:63 msg="Initializing logging reporter\n"
ts=2020-06-29T21:57:08.429215Z caller=database.go:25 database="setting up sqlite database provider"
ts=2020-06-29T21:57:08.429252Z caller=sqlite.go:97 main="sqlite version 3.31.1"
ts=2020-06-29T21:57:08.43175Z caller=main.go:87 admin="listening on [::]:9092"
ts=2020-06-29T21:57:08.433259Z caller=main.go:134 main="registered America/New_York cutoffs=16:20"
ts=2020-06-29T21:57:08.43329Z caller=aggregate.go:72 aggregate="setup *audittrail.MockStorage audit storage"
ts=2020-06-29T21:57:08.433309Z caller=aggregate.go:78 aggregate="setup []transform.PreUpload(nil) pre-upload transformers"
ts=2020-06-29T21:57:08.433317Z caller=aggregate.go:84 aggregate="setup *output.NACHA output formatter"
ts=2020-06-29T21:57:08.433379Z caller=client.go:186 customers="using http://localhost:8087 for Customers address"
ts=2020-06-29T21:57:08.433623Z caller=scheduler.go:44 inbound="starting inbound processor with interval=10m0s"
ts=2020-06-29T21:57:08.433635Z caller=main.go:207 startup="binding to :8082 for HTTP server"

Getting Help

channel	info
Project Documentation	Our project documentation available online.
Hosted Documentation	Hosted documentation for enterprise solutions.
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 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.

Supported and Tested Platforms

• 64-bit Linux (Ubuntu, Debian), macOS, and Windows

Contributing

Yes please! Please review our Contributing guide and Code of Conduct to get started! Checkout our issues for first time contributors for something to help out with.

Paygate includes several "long" tests which spawn Docker containers, make requests over the internet, and perform more complicated tests. To skip these long tests add the -short flag to go test.

This project uses Go Modules and uses Go 1.14 or higher. See Golang's install instructions for help setting up Go. You can download the source code and we offer tagged and released versions as well. We highly recommend you use a tagged release for production.

Further Reading

• The default banking-as-a-service platform will be developer-first

Test Coverage

Improving test coverage is a good candidate for new contributors while also allowing the project to move more quickly by reducing regressions issues that might not be caught before a release is pushed out to our users. One great way to improve coverage is by adding edge cases and different inputs to functions (or contributing and running fuzzers).

Tests can run processes (like sqlite databases), but should only do so locally.

Each PR should increase the overall coverage, if possible. You can run make cover-test to save a coverage profile and make cover-web to open the HTML view in your default browser.

License

Apache License 2.0 See LICENSE for details.

Documentation

Overview

Package paygate will hold common types which are useful for working with paygate's HTTP endpoints.

Index

• Constants

Constants

const Version = "v0.8.0-dev"

Version number