Skip to content

Commit d467cf4

Browse files
committed
docs: add examples for ach and wire (by routing number)
1 parent dd39123 commit d467cf4

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

+58
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,64 @@ Docs: [docs.moov.io](https://docs.moov.io/en/latest/) | [api docs](https://api.m
2121

2222
Note: The Docker image ships with old data files (`FedACHdir.txt` and `fpddir.txt`) as example data. In a production deployment updated files should be obtained from your Financial Institution and provided to the server process.
2323

24+
#### ACH Routing Number Example
25+
26+
Fed can be used to lookup a Financial Institutions for Automated Clearing House ([ACH](https://en.wikipedia.org/wiki/Automated_Clearing_House)) transfers by their routing number (`?routingNumber=...`) or name (`?name=...`):
27+
28+
```
29+
$ curl -s localhost:8086/fed/ach/search?routingNumber=273976369 | jq .
30+
{
31+
"achParticipants": [
32+
{
33+
"routingNumber": "273976369",
34+
"officeCode": "O",
35+
"servicingFRBNumber": "071000301",
36+
"recordTypeCode": "1",
37+
"revised": "041513",
38+
"newRoutingNumber": "000000000",
39+
"customerName": "VERIDIAN CREDIT UNION",
40+
"achLocation": {
41+
"address": "1827 ANSBOROUGH",
42+
"city": "WATERLOO",
43+
"state": "IA",
44+
"postalCode": "50702",
45+
"postalCodeExtension": "0000"
46+
},
47+
"phoneNumber": "3192878332",
48+
"statusCode": "1",
49+
"viewCode": "1"
50+
}
51+
],
52+
"wireParticipants": null
53+
}
54+
```
55+
56+
#### Wire Routing Number Example
57+
58+
Fed can be used to lookup a Financial Institutions for FED Wire Messages ([FEDWire](https://en.wikipedia.org/wiki/Fedwire)) by their routing number (`?routingNumber=...`) or name (`?name=...`):
59+
60+
```
61+
$ curl -s localhost:8086/fed/wire/search?routingNumber=273976369 | jq .
62+
{
63+
"achParticipants": null,
64+
"wireParticipants": [
65+
{
66+
"routingNumber": "273976369",
67+
"telegraphicName": "VERIDIAN",
68+
"customerName": "VERIDIAN CREDIT UNION",
69+
"wireLocation": {
70+
"city": "WATERLOO",
71+
"state": "IA"
72+
},
73+
"fundsTransferStatus": "Y",
74+
"fundsSettlementOnlyStatus": " ",
75+
"bookEntrySecuritiesTransferStatus": "N",
76+
"date": "20141107"
77+
}
78+
]
79+
}
80+
```
81+
2482
### Configuration
2583

2684
| Environmental Variable | Description | Default |

0 commit comments

Comments
 (0)