Skip to content

Commit

Permalink
meta: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdecaf committed Nov 22, 2024
1 parent 3b62646 commit 6d007b3
Showing 1 changed file with 54 additions and 2 deletions.
56 changes: 54 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,54 @@
# fednow20022
The FedNow ISO 20022 specifications
[![Moov Banner Logo](https://user-images.githubusercontent.com/20115216/104214617-885b3c80-53ec-11eb-8ce0-9fc745fb5bfc.png)](https://github.com/moov-io)

<p align="center">
<a href="https://slack.moov.io/">Community</a>
·
<a href="https://moov.io/blog/">Blog</a>
<br>
<br>
</p>

[![GoDoc](https://godoc.org/github.com/moov-io/fednow20022?status.svg)](https://godoc.org/github.com/moov-io/fednow20022)
[![Build Status](https://github.com/moov-io/fednow20022/workflows/Go/badge.svg)](https://github.com/moov-io/fednow20022/actions)
[![Coverage Status](https://codecov.io/gh/moov-io/fednow20022/branch/master/graph/badge.svg)](https://codecov.io/gh/moov-io/fednow20022)
[![Go Report Card](https://goreportcard.com/badge/github.com/moov-io/fednow20022)](https://goreportcard.com/report/github.com/moov-io/fednow20022)
[![Repo Size](https://img.shields.io/github/languages/code-size/moov-io/fednow20022?label=project%20size)](https://github.com/moov-io/fednow20022)
[![Apache 2 License](https://img.shields.io/badge/license-Apache2-blue.svg)](https://raw.githubusercontent.com/moov-io/fednow20022/master/LICENSE)
[![Slack Channel](https://slack.moov.io/badge.svg?bg=e01563&fgColor=fffff)](https://slack.moov.io/)
[![GitHub Stars](https://img.shields.io/github/stars/moov-io/fednow20022)](https://github.com/moov-io/fednow20022)
[![Twitter](https://img.shields.io/twitter/follow/moov?style=social)](https://twitter.com/moov?lang=en)


## moov-io/fednow20022

Moov's mission is to give developers an easy way to create and integrate bank processing into their own software products. Our open source projects are each focused on solving a single responsibility in financial services and designed around performance, scalability, and ease of use.

This repository contains a subset of ISO 20022 messages for FedNow payments. ISO 20022 is a standard for electronic data interchange between financial institutions. It describes a metadata repository containing descriptions of messages and business processes, and a maintenance process for the repository content. The standard covers financial information transferred between financial institutions that includes payment transactions, securities trading and settlement information, credit and debit card transactions, and other financial information.

Refer to the [FedNow Explorer](https://explore.fednow.org/) and [FedNow technical documentation](https://www.frbservices.org/resources/financial-services/wires/faq/iso-20022/format-technical-documentation-mystandards) for more information.

## Project Status

Go code is [generated with `xsdgen`](https://pkg.go.dev/aqwari.net/xml/cmd/xsdgen) inside the `gen/` folder. Please star the project if you are interested in its progress. Feedback on this early version of ISO 20022 is appreciated and vital to its success. Please let us know if you encounter any bugs/unclear documentation or have feature suggestions by opening up an issue. Thanks!

## Usage

### Go Library

This project offers Go structures which can read and write XML encoded ISO 20022 messages. Go has several [known limitations around XML namespace prefixes](https://github.com/golang/go/issues/13400) which are required for FedNow messages. Encoding messages can include namespace prefixes (`xml:"ns:Name"`) but decoding messages cannot (`xml:"Name"`).

## Getting Help

channel | info
------- | -------
Twitter [@moov](https://twitter.com/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](https://github.com/moov-io/fednow20022/issues/new) | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error.
[moov-io slack](https://slack.moov.io/) | Join our slack channel (`#fednow20022`) to have an interactive discussion about the development of the project.

## Supported and Tested Platforms

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

## License

Apache License 2.0 - See [LICENSE](LICENSE) for details.

0 comments on commit 6d007b3

Please sign in to comment.