# README
Go API client for openapi
Moov Wire implements an HTTP API for creating, parsing, and validating Fedwire messages.
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/wire
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 "./openapi"
Documentation for API Endpoints
All URIs are relative to http://localhost:8088
| Class | Method | HTTP request | Description |
|---|---|---|---|
| WireFilesApi | AddFEDWireMessageToFile | Post /files/{fileID}/FEDWireMessage | Add Fedwire message to file |
| WireFilesApi | CreateWireFile | Post /files/create | Create file |
| WireFilesApi | DeleteWireFileByID | Delete /files/{fileID} | Delete file |
| WireFilesApi | GetWireFileByID | Get /files/{fileID} | Retrieve file |
| WireFilesApi | GetWireFileContents | Get /files/{fileID}/contents | Get file contents |
| WireFilesApi | GetWireFiles | Get /files | List files |
| WireFilesApi | Ping | Get /ping | Ping Wire service |
| WireFilesApi | ValidateWireFile | Get /files/{fileID}/validate | Validate file |
Documentation For Models
- AccountCreditedDrawdown
- AccountDebitedDrawdown
- AdditionalFiToFi
- Adjustment
- Advice
- Beneficiary
- BeneficiaryReference
- BusinessFunctionCode
- Charges
- CoverPayment
- CurrencyInstructedAmount
- DateRemittanceDocument
- Error
- ErrorWire
- ExchangeRate
- FedWireMessage
- FiPaymentMethodToBeneficiary
- FiToFi
- FinancialInstitution
- InputMessageAccountabilityData
- InstructedAmount
- LocalInstrument
- MessageDisposition
- OriginatorOptionF
- OriginatorToBeneficiary
- OutputMessageAccountabilityData
- PaymentNotification
- Personal
- PreviousMessageIdentifier
- PrimaryRemittanceDocument
- ReceiptTimeStamp
- ReceiverDepositoryInstitution
- RelatedRemittance
- RemittanceAmount
- RemittanceBeneficiary
- RemittanceData
- RemittanceFreeText
- RemittanceOriginator
- SecondaryRemittanceDocument
- SenderDepositoryInstitution
- SenderReference
- SenderSupplied
- ServiceMessage
- TypeSubType
- UnstructuredAddenda
- ValidateOptions
- WireAddress
- WireAmount
- WireFile
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
AccountCreditedDrawdown AccountCreditedDrawdown is the account which is credited in a drawdown.
AccountDebitedDrawdown AccountDebitedDrawdown is the account which is debited in a drawdown.
AddFEDWireMessageToFileOpts Optional parameters for the method 'AddFEDWireMessageToFile'.
AdditionalFiToFi struct for AdditionalFiToFi.
Adjustment struct for Adjustment.
Advice struct for Advice.
APIClient manages communication with the Wire 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.
Beneficiary struct for Beneficiary.
BeneficiaryReference struct for BeneficiaryReference.
BusinessFunctionCode struct for BusinessFunctionCode.
Charges struct for Charges.
Configuration stores the configuration of the API client.
CoverPayment struct for CoverPayment.
CreateWireFileOpts Optional parameters for the method 'CreateWireFile'.
CurrencyInstructedAmount struct for CurrencyInstructedAmount.
DateRemittanceDocument struct for DateRemittanceDocument.
DeleteWireFileByIDOpts Optional parameters for the method 'DeleteWireFileByID'.
Error struct for Error.
ErrorWire struct for ErrorWire.
ExchangeRate struct for ExchangeRate.
FedWireMessage struct for FedWireMessage.
FinancialInstitution FinancialInstitution is financial institution demographic information.
FiPaymentMethodToBeneficiary struct for FiPaymentMethodToBeneficiary.
FiToFi struct for FiToFi.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetWireFileByIDOpts Optional parameters for the method 'GetWireFileByID'.
GetWireFileContentsOpts Optional parameters for the method 'GetWireFileContents'.
GetWireFilesOpts Optional parameters for the method 'GetWireFiles'.
InputMessageAccountabilityData struct for InputMessageAccountabilityData.
InstructedAmount struct for InstructedAmount.
LocalInstrument struct for LocalInstrument.
MessageDisposition struct for MessageDisposition.
OriginatorOptionF struct for OriginatorOptionF.
OriginatorToBeneficiary struct for OriginatorToBeneficiary.
OutputMessageAccountabilityData struct for OutputMessageAccountabilityData.
PaymentNotification struct for PaymentNotification.
Personal Personal is personal demographic information.
PreviousMessageIdentifier The identifier for a previous message.
PrimaryRemittanceDocument struct for PrimaryRemittanceDocument.
ReceiptTimeStamp struct for ReceiptTimeStamp.
ReceiverDepositoryInstitution ReceiverDepositoryInstitution is the receiver depository institution.
RelatedRemittance struct for RelatedRemittance.
RemittanceAmount struct for RemittanceAmount.
RemittanceBeneficiary struct for RemittanceBeneficiary.
RemittanceData struct for RemittanceData.
RemittanceFreeText struct for RemittanceFreeText.
RemittanceOriginator struct for RemittanceOriginator.
SecondaryRemittanceDocument struct for SecondaryRemittanceDocument.
SenderDepositoryInstitution SenderDepositoryInstitution is the receiver depository institution.
SenderReference struct for SenderReference.
SenderSupplied struct for SenderSupplied.
ServiceMessage struct for ServiceMessage.
TypeSubType struct for TypeSubType.
UnstructuredAddenda struct for UnstructuredAddenda.
ValidateOptions struct for ValidateOptions.
ValidateWireFileOpts Optional parameters for the method 'ValidateWireFile'.
WireAddress Identifies Address.
WireAmount Maximum amount is a penny less than $10 billion.
WireFile struct for WireFile.
# Type aliases
WireFilesApiService WireFilesApi service.