package
0.11.1
Repository: https://github.com/moov-io/fed.git
Documentation: pkg.go.dev

# README

Go API client for client

FED API is designed to create FEDACH and FEDWIRE dictionaries. The FEDACH dictionary contains receiving depository financial institutions (RDFI’s) which are qualified to receive ACH entries. The FEDWIRE dictionary contains receiving depository financial institutions (RDFI’s) which are qualified to receive WIRE entries. This project implements a modern REST HTTP API for FEDACH Dictionary and FEDWIRE Dictionary.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/moov-io/fed

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./client"

Documentation for API Endpoints

All URIs are relative to http://localhost:8086

ClassMethodHTTP requestDescription
FEDApiPingGet /pingPing the FED service to check if running
FEDApiSearchFEDACHGet /fed/ach/searchSearch FEDACH names and metadata
FEDApiSearchFEDWIREGet /fed/wire/searchSearch FEDWIRE names and metadata

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

AchDictionary Search results containing ACHDictionary of Participants.
AchLocation ACHLocation is the FEDACH delivery address.
AchParticipant ACHParticipant holds a FedACH dir routing record as defined by Fed ACH Format.
APIClient manages communication with the FED API API vv1 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Logo Company logo of the Fed ACH or Wire participant.
SearchFEDACHOpts Optional parameters for the method 'SearchFEDACH'.
SearchFEDWIREOpts Optional parameters for the method 'SearchFEDWIRE'.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
WireDictionary Search results containing WIREDictionary of Participants.
WireLocation WIRELocation is the FEDWIRE delivery address.
WireParticipant WIREParticipant holds a FedWIRE dir routing record as defined by Fed WIRE Format.

# Type aliases

FEDApiService FEDApi service.