Documentation
¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AccountCreditedDrawdown
- type AccountDebitedDrawdown
- type AddFEDWireMessageToFileOpts
- type AdditionalFiToFi
- type Address
- type Adjustment
- type Advice
- type Amount
- type BasicAuth
- type BeneficiaryReference
- type BusinessFunctionCode
- type Charges
- type Configuration
- type CoverPayment
- type CreateFile
- type CreateWireFileOpts
- type CurrencyInstructedAmount
- type DateRemittanceDocument
- type DeleteWireFileByIDOpts
- type Error
- type ErrorWire
- type ExchangeRate
- type FEDWireMessageFileApiService
- type FedWireMessage
- type FiPaymentMethodToBeneficiary
- type FiToFi
- type File
- type FinancialInstitution
- type GenericOpenAPIError
- type GetWireFileByIDOpts
- type GetWireFileContentsOpts
- type GetWireFilesOpts
- type InputMessageAccountabilityData
- type InstructedAmount
- type LocalInstrument
- type MessageDisposition
- type OriginatorOptionF
- type OriginatorToBeneficiary
- type OutputMessageAccountabilityData
- type PaymentNotification
- type Personal
- type PreviousMessageIdentifier
- type PrimaryRemittanceDocument
- type ReceiptTimeStamp
- type ReceiverDepositoryInstitution
- type RelatedRemittance
- type RemittanceAmount
- type RemittanceBeneficiary
- type RemittanceData
- type RemittanceFreeText
- type RemittanceOriginator
- type SecondaryRemittanceDocument
- type SenderDepositoryInstitution
- type SenderReference
- type SenderSupplied
- type ServiceMessage
- type TypeSubType
- type UnstructuredAddenda
- type UpdateWireFileByIDOpts
- type ValidateWireFileOpts
- type WireFilesApiService
- func (a *WireFilesApiService) CreateWireFile(ctx context.Context, createFile CreateFile, ...) (File, *http.Response, error)
- func (a *WireFilesApiService) DeleteWireFileByID(ctx context.Context, fileID string, localVarOptionals *DeleteWireFileByIDOpts) (*http.Response, error)
- func (a *WireFilesApiService) GetWireFileByID(ctx context.Context, fileID string, localVarOptionals *GetWireFileByIDOpts) (File, *http.Response, error)
- func (a *WireFilesApiService) GetWireFileContents(ctx context.Context, fileID string, localVarOptionals *GetWireFileContentsOpts) (string, *http.Response, error)
- func (a *WireFilesApiService) GetWireFiles(ctx context.Context, localVarOptionals *GetWireFilesOpts) ([]File, *http.Response, error)
- func (a *WireFilesApiService) Ping(ctx context.Context) (*http.Response, error)
- func (a *WireFilesApiService) UpdateWireFileByID(ctx context.Context, fileID string, createFile CreateFile, ...) (File, *http.Response, error)
- func (a *WireFilesApiService) ValidateWireFile(ctx context.Context, fileID string, localVarOptionals *ValidateWireFileOpts) (File, *http.Response, error)
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes an oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct {
FEDWireMessageFileApi *FEDWireMessageFileApiService
WireFilesApi *WireFilesApiService
// contains filtered or unexported fields
}
APIClient manages communication with the WIRE API API vv1 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
Change base path to allow switching to mocks
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct {
*http.Response `json:"-"`
Message string `json:"message,omitempty"`
// Operation is the name of the OpenAPI operation.
Operation string `json:"operation,omitempty"`
// RequestURL is the request URL. This value is always available, even if the
// embedded *http.Response is nil.
RequestURL string `json:"url,omitempty"`
// Method is the HTTP method used for the request. This value is always
// available, even if the embedded *http.Response is nil.
Method string `json:"method,omitempty"`
// Payload holds the contents of the response body (which may be nil or empty).
// This is provided here as the raw response.Body() reader will have already
// been drained.
Payload []byte `json:"-"`
}
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
type AccountCreditedDrawdown ¶
type AccountCreditedDrawdown struct {
// DrawdownCreditAccountNumber 9 character ABA
DrawdownCreditAccountNumber string `json:"drawdownCreditAccountNumber,omitempty"`
}
AccountCreditedDrawdown is the account which is credited in a drawdown
type AccountDebitedDrawdown ¶
type AccountDebitedDrawdown struct {
// Identification Code * `D` - Debit
IdentificationCode string `json:"identificationCode"`
// Identifier
Identifier string `json:"identifier"`
// Name
Name string `json:"name"`
// AddressLineOne
AddressLineOne string `json:"addressLineOne,omitempty"`
// AddressLineTwo
AddressLineTwo string `json:"addressLineTwo,omitempty"`
// AddressLineThree
AddressLineThree string `json:"addressLineThree,omitempty"`
}
AccountDebitedDrawdown is the account which is debited in a drawdown
type AddFEDWireMessageToFileOpts ¶ added in v0.3.0
type AdditionalFiToFi ¶
type AdditionalFiToFi struct {
// LineOne
LineOne string `json:"lineOne,omitempty"`
// LineTwo
LineTwo string `json:"lineTwo,omitempty"`
// LineThree
LineThree string `json:"lineThree,omitempty"`
// LineFour
LineFour string `json:"lineFour,omitempty"`
// LineFive
LineFive string `json:"lineFive,omitempty"`
// LineSix
LineSix string `json:"lineSix,omitempty"`
}
type Address ¶
type Address struct {
// AddressLineOne
AddressLineOne string `json:"addressLineOne,omitempty"`
// AddressLineTwo
AddressLineTwo string `json:"addressLineTwo,omitempty"`
// AddressLineThree
AddressLineThree string `json:"addressLineThree,omitempty"`
}
Identifies Address
type Adjustment ¶
type Adjustment struct {
// Adjustment Reason Code * `01` - Pricing Error * `03` - Extension Error * `04` - Item Not Accepted (Damaged) * `05` - Item Not Accepted (Quality) * `06` - Quantity Contested 07 Incorrect Product * `11` - Returns (Damaged) * `12` - Returns (Quality) * `59` - Item Not Received * `75` - Total Order Not Received * `81` - Credit as Agreed * `CM` - Covered by Credit Memo
AdjustmentReasonCode string `json:"adjustmentReasonCode,omitempty"`
// CreditDebitIndicator * `CRDT` - Credit * `DBIT` - Debit
CreditDebitIndicator string `json:"creditDebitIndicator,omitempty"`
// CurrencyCode
CurrencyCode string `json:"currencyCode,omitempty"`
// Amount Must contain at least one numeric character and only one decimal period marker (e.g., $1,234.56 should be entered as 1234.56). Can have up to 5 numeric characters following the decimal period marker (e.g., 1234.56789). Amount must be greater than zero (i.e., at least .01).
Amount string `json:"amount,omitempty"`
// AdditionalInfo
AdditionalInfo string `json:"additionalInfo,omitempty"`
}
Adjustment
type Advice ¶
type Advice struct {
// Advice Code * `HLD - Hold * `LTR` - Letter * `PHN` - Phone * `TLX` - Telex * `WRE` - Wire
AdviceCode string `json:"adviceCode,omitempty"`
// LineOne
LineOne string `json:"lineOne,omitempty"`
// LineTwo
LineTwo string `json:"lineTwo,omitempty"`
// LineThree
LineThree string `json:"lineThree,omitempty"`
// LineFour
LineFour string `json:"lineFour,omitempty"`
// LineFive
LineFive string `json:"lineFive,omitempty"`
// LineSix
LineSix string `json:"lineSix,omitempty"`
}
Advice
type Amount ¶
type Amount struct {
// Amount 12 numeric, right-justified with leading zeros, an implied decimal point and no commas; e.g., $12,345.67 becomes 000001234567 Can be all zeros for subtype 90
Amount string `json:"amount"`
}
Amount is an amount up to a penny less than $10 billion
type BasicAuth ¶
type BasicAuth struct {
UserName string `json:"userName,omitempty"`
Password string `json:"password,omitempty"`
}
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type BeneficiaryReference ¶
type BeneficiaryReference struct {
// BeneficiaryReference
BeneficiaryReference string `json:"beneficiaryReference,omitempty"`
}
type BusinessFunctionCode ¶
type BusinessFunctionCode struct {
// BusinessFunctionCode * `BTR` - Bank Transfer (Beneficiary is a bank) * `DRC` - Customer or Corporate Drawdown Request * `CKS` - Check Same Day Settlement * `DRW` - Drawdown Payment * `CTP` - Customer Transfer Plus * `FFR` - Fed Funds Returned * `CTR` - Customer Transfer (Beneficiary is a not a bank) * `FFS` - Fed Funds Sold * `DEP` - Deposit to Sender’s Account * `SVC` - Service Message * `DRB` - Bank-to-Bank Drawdown Request
BusinessFunctionCode string `json:"businessFunctionCode"`
// TransactionTypeCode If {3600} is CTR, an optional Transaction Type Code element is permitted; however, the Transaction Type Code 'COV' is not permitted.
TransactionTypeCode string `json:"transactionTypeCode,omitempty"`
}
BusinessFunctionCode is the business function code
type Charges ¶
type Charges struct {
// Charge Details * `B` - Beneficiary * `S` - Shared
ChargeDetails string `json:"chargeDetails,omitempty"`
// SendersChargesOne The first three characters must contain an alpha currency code (e.g., USD). The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker. $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
SendersChargesOne string `json:"sendersChargesOne,omitempty"`
// SendersChargesTwo The first three characters must contain an alpha currency code (e.g., USD). The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker. $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
SendersChargesTwo string `json:"sendersChargesTwo,omitempty"`
// SendersChargesThree The first three characters must contain an alpha currency code (e.g., USD). The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker. $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
SendersChargesThree string `json:"sendersChargesThree,omitempty"`
// SendersChargesFour The first three characters must contain an alpha currency code (e.g., USD). The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker. $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
SendersChargesFour string `json:"sendersChargesFour,omitempty"`
}
type Configuration ¶
type Configuration struct {
BasePath string `json:"basePath,omitempty"`
Host string `json:"host,omitempty"`
Scheme string `json:"scheme,omitempty"`
DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
UserAgent string `json:"userAgent,omitempty"`
HTTPClient *http.Client
}
func NewConfiguration ¶
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
type CoverPayment ¶
type CoverPayment struct {
// SwiftFieldTag
SwiftFieldTag string `json:"swiftFieldTag,omitempty"`
// SwiftLineOne
SwiftLineOne string `json:"swiftLineOne,omitempty"`
// SwiftLineTwo
SwiftLineTwo string `json:"swiftLineTwo,omitempty"`
// SwiftLineThree
SwiftLineThree string `json:"swiftLineThree,omitempty"`
// SwiftLineFour
SwiftLineFour string `json:"swiftLineFour,omitempty"`
// SwiftLineFive
SwiftLineFive string `json:"swiftLineFive,omitempty"`
// SwiftLineSix
SwiftLineSix string `json:"swiftLineSix,omitempty"`
}
CoverPayment
type CreateFile ¶
type CreateFile struct {
// File ID
ID string `json:"ID,omitempty"`
FedWireMessage []FedWireMessage `json:"fedWireMessage,omitempty"`
}
type CreateWireFileOpts ¶
type CurrencyInstructedAmount ¶
type CurrencyInstructedAmount struct {
// SwiftFieldTag
SwiftFieldTag string `json:"swiftFieldTag,omitempty"`
// Amount
Amount string `json:"amount,omitempty"`
}
CurrencyInstructedAmount
type DateRemittanceDocument ¶
type DateRemittanceDocument struct {
// DateRemittanceDocument CCYYMMDD
DateRemittanceDocument string `json:"dateRemittanceDocument,omitempty"`
}
type DeleteWireFileByIDOpts ¶
type Error ¶
type Error struct {
// An error message describing the problem intended for humans.
Error string `json:"error"`
}
type ErrorWire ¶
type ErrorWire struct {
// ErrorCategory * `E` - Data Error * `F` - Insufficient Balance * `H` - Accountability Error * `I` - In Process or Intercepted * `W` - Cutoff Hour Error * `X` - Duplicate IMAD
ErrorCategory string `json:"errorCategory,omitempty"`
// ErrorCode
ErrorCode string `json:"errorCode,omitempty"`
// ErrorDescription
ErrorDescription string `json:"errorDescription,omitempty"`
}
ErrorWire
type ExchangeRate ¶
type ExchangeRate struct {
// ExchangeRate is the exchange rate Must contain at least one numeric character and only one decimal comma marker (e.g., an exchange rate of 1.2345 should be entered as 1,2345).
ExchangeRate string `json:"exchangeRate,omitempty"`
}
ExchangeRate is the exchange rate
type FEDWireMessageFileApiService ¶ added in v0.3.0
type FEDWireMessageFileApiService service
func (*FEDWireMessageFileApiService) AddFEDWireMessageToFile ¶ added in v0.3.0
func (a *FEDWireMessageFileApiService) AddFEDWireMessageToFile(ctx context.Context, fileID string, fedWireMessage FedWireMessage, localVarOptionals *AddFEDWireMessageToFileOpts) (*http.Response, error)
type FedWireMessage ¶
type FedWireMessage struct {
// FEDWireMessage ID
ID string `json:"ID,omitempty"`
MessageDisposition MessageDisposition `json:"messageDisposition,omitempty"`
ReceiptTimeStamp ReceiptTimeStamp `json:"receiptTimeStamp,omitempty"`
OutputMessageAccountabilityData OutputMessageAccountabilityData `json:"outputMessageAccountabilityData,omitempty"`
ErrorWire ErrorWire `json:"errorWire,omitempty"`
SenderSupplied SenderSupplied `json:"senderSupplied"`
TypeSubType TypeSubType `json:"typeSubType"`
InputMessageAccountabilityData InputMessageAccountabilityData `json:"inputMessageAccountabilityData"`
Amount Amount `json:"amount"`
SenderDepositoryInstitution SenderDepositoryInstitution `json:"senderDepositoryInstitution"`
ReceiverDepositoryInstitution ReceiverDepositoryInstitution `json:"receiverDepositoryInstitution"`
BusinessFunctionCode BusinessFunctionCode `json:"businessFunctionCode"`
SenderReference SenderReference `json:"senderReference,omitempty"`
PreviousMessageIdentifier PreviousMessageIdentifier `json:"previousMessageIdentifier,omitempty"`
LocalInstrument LocalInstrument `json:"localInstrument,omitempty"`
PaymentNotification PaymentNotification `json:"paymentNotification,omitempty"`
Charges Charges `json:"charges,omitempty"`
InstructedAmount InstructedAmount `json:"instructedAmount,omitempty"`
ExchangeRate ExchangeRate `json:"exchangeRate,omitempty"`
BeneficiaryIntermediaryFI FinancialInstitution `json:"beneficiaryIntermediaryFI,omitempty"`
BeneficiaryFI FinancialInstitution `json:"beneficiaryFI,omitempty"`
Beneficiary Personal `json:"beneficiary,omitempty"`
BeneficiaryReference BeneficiaryReference `json:"beneficiaryReference,omitempty"`
AccountDebitedDrawdown AccountDebitedDrawdown `json:"accountDebitedDrawdown,omitempty"`
Originator Personal `json:"originator,omitempty"`
OriginatorOptionF OriginatorOptionF `json:"originatorOptionF,omitempty"`
OriginatorFI FinancialInstitution `json:"originatorFI,omitempty"`
InstructingFI FinancialInstitution `json:"instructingFI,omitempty"`
AccountCreditedDrawdown AccountCreditedDrawdown `json:"accountCreditedDrawdown,omitempty"`
OriginatorToBeneficiary OriginatorToBeneficiary `json:"originatorToBeneficiary,omitempty"`
FiReceiverFI FiToFi `json:"fiReceiverFI,omitempty"`
FiDrawdownDebitAccountAdvice Advice `json:"fiDrawdownDebitAccountAdvice,omitempty"`
FiIntermediaryFI FiToFi `json:"fiIntermediaryFI,omitempty"`
FiIntermediaryFIAdvice Advice `json:"fiIntermediaryFIAdvice,omitempty"`
FiBeneficiaryFI FiToFi `json:"fiBeneficiaryFI,omitempty"`
FiBeneficiaryFIAdvice Advice `json:"fiBeneficiaryFIAdvice,omitempty"`
FiBeneficiary FiToFi `json:"fiBeneficiary,omitempty"`
FiBeneficiaryAdvice Advice `json:"fiBeneficiaryAdvice,omitempty"`
FiPaymentMethodToBeneficiary FiPaymentMethodToBeneficiary `json:"fiPaymentMethodToBeneficiary,omitempty"`
FiAdditionalFIToFI AdditionalFiToFi `json:"fiAdditionalFIToFI,omitempty"`
CurrencyInstructedAmount CurrencyInstructedAmount `json:"currencyInstructedAmount,omitempty"`
OrderingCustomer CoverPayment `json:"orderingCustomer,omitempty"`
OrderingInstitution CoverPayment `json:"orderingInstitution,omitempty"`
IntermediaryInstitution CoverPayment `json:"intermediaryInstitution,omitempty"`
InstitutionAccount CoverPayment `json:"institutionAccount,omitempty"`
BeneficiaryCustomer CoverPayment `json:"beneficiaryCustomer,omitempty"`
Remittance CoverPayment `json:"remittance,omitempty"`
SenderToReceiver CoverPayment `json:"senderToReceiver,omitempty"`
UnstructuredAddenda UnstructuredAddenda `json:"unstructuredAddenda,omitempty"`
RelatedRemittance RelatedRemittance `json:"relatedRemittance,omitempty"`
RemittanceOriginator RemittanceOriginator `json:"remittanceOriginator,omitempty"`
RemittanceBeneficiary RemittanceBeneficiary `json:"remittanceBeneficiary,omitempty"`
PrimaryRemittanceDocument PrimaryRemittanceDocument `json:"primaryRemittanceDocument,omitempty"`
ActualAmountPaid RemittanceAmount `json:"actualAmountPaid,omitempty"`
GrossAmountRemittanceDocument RemittanceAmount `json:"grossAmountRemittanceDocument,omitempty"`
AmountNegotiatedDiscount RemittanceAmount `json:"amountNegotiatedDiscount,omitempty"`
Adjustment Adjustment `json:"adjustment,omitempty"`
DateRemittanceDocument DateRemittanceDocument `json:"dateRemittanceDocument,omitempty"`
SecondaryRemittanceDocument SecondaryRemittanceDocument `json:"secondaryRemittanceDocument,omitempty"`
RemittanceFreeText RemittanceFreeText `json:"remittanceFreeText,omitempty"`
ServiceMessage ServiceMessage `json:"serviceMessage,omitempty"`
}
type FiToFi ¶
type FiToFi struct {
// LineOne
LineOne string `json:"lineOne,omitempty"`
// LineTwo
LineTwo string `json:"lineTwo,omitempty"`
// LineThree
LineThree string `json:"lineThree,omitempty"`
// LineFour
LineFour string `json:"lineFour,omitempty"`
// LineFive
LineFive string `json:"lineFive,omitempty"`
// LineSix
LineSix string `json:"lineSix,omitempty"`
}
FIToFI
type File ¶
type File struct {
// File ID
ID string `json:"ID,omitempty"`
FedWireMessage []FedWireMessage `json:"fedWireMessage"`
}
type FinancialInstitution ¶
type FinancialInstitution struct {
// Identification Code: * `B` - SWIFT Bank Identifier Code (BIC) * `C` - CHIPS Participant * `D` - Demand Deposit Account (DDA) Number * `F` - Fed Routing Number * `T` - SWIFT BIC or Bank Entity Identifier (BEI) and Account Number * `U` - CHIPS Identifier
IdentificationCode string `json:"identificationCode"`
// Identifier
Identifier string `json:"identifier"`
// Name
Name string `json:"name"`
Address Address `json:"address"`
}
FinancialInstitution is financial institution demographic information
type GenericOpenAPIError ¶
type GenericOpenAPIError struct {
// contains filtered or unexported fields
}
GenericOpenAPIError Provides access to the body, error and model on returned errors.
func (GenericOpenAPIError) Body ¶
func (e GenericOpenAPIError) Body() []byte
Body returns the raw bytes of the response
func (GenericOpenAPIError) Error ¶
func (e GenericOpenAPIError) Error() string
Error returns non-empty string if there was an error.
func (GenericOpenAPIError) Model ¶
func (e GenericOpenAPIError) Model() interface{}
Model returns the unpacked model of the error
type GetWireFileByIDOpts ¶
type GetWireFileContentsOpts ¶
type GetWireFilesOpts ¶
type InputMessageAccountabilityData ¶
type InputMessageAccountabilityData struct {
// InputCycleDate CCYYMMDD
InputCycleDate string `json:"inputCycleDate"`
// InputSource
InputSource string `json:"inputSource"`
// InputSequenceNumber
InputSequenceNumber string `json:"inputSequenceNumber"`
}
InputMessageAccountabilityData (IMAD)
type InstructedAmount ¶
type InstructedAmount struct {
// CurrencyCode
CurrencyCode string `json:"currencyCode,omitempty"`
// Amount Must begin with at least one numeric character (0-9) and contain only one decimal comma marker (e.g., $1,234.56 should be entered as 1234,56 and $0.99 should be entered as
Amount string `json:"amount,omitempty"`
}
InstructedAmount is the instructed amount
type LocalInstrument ¶
type LocalInstrument struct {
// LocalInstrument * `ANSI` - ANSI X12 format * `COVS` - Sequence B Cover Payment Structured * `GXML` - General XML format * `IXML` - ISO 20022 XML formaT * `NARR` - Narrative Text * `PROP` - Proprietary Local Instrument Code * `RMTS` - Remittance Information Structured * `RRMT` - Related Remittance Information * `S820` - STP 820 format * `SWIF` - SWIFT field 70 (Remittance Information) * `UEDI` - UN/EDIFACT format
LocalInstrumentCode string `json:"localInstrumentCode,omitempty"`
// ProprietaryCode
ProprietaryCode string `json:"proprietaryCode,omitempty"`
}
LocalInstrument is the local instrument
type MessageDisposition ¶
type MessageDisposition struct {
// formatVersion identifies the format version 30
FormatVersion string `json:"formatVersion,omitempty"`
// testProductionCode identifies if test or production. * `T` - Test * `P` - Production
TestProductionCode string `json:"testProductionCode,omitempty"`
// MessageDuplicationCode * ` ` - Original Message * `R` - Retrieval of an original message * `P` - Resend
MessageDuplicationCode string `json:"messageDuplicationCode,omitempty"`
// MessageStatusIndicator Outgoing Messages * `0` - In process or Intercepted * `2` - Successful with Accounting (Value) * `3` - Rejected due to Error Condition * `7` - Successful without Accounting (Non-Value) Incoming Messages * `N` - Successful with Accounting (Value) * `S` - Successful without Accounting (Non-Value)
MessageStatusIndicator string `json:"messageStatusIndicator,omitempty"`
}
type OriginatorOptionF ¶
type OriginatorOptionF struct {
// PartyIdentifier Must be one of the following two formats: 1. /Account Number (slash followed by at least one valid non-space character: e.g., /123456) 2. Unique Identifier/ (4 character code followed by a slash and at least one valid non-space character: e.g., SOSE/123-456-789) ARNU: Alien Registration Number CCPT: Passport Number CUST: Customer Identification Number DRLC/ Driver’s License Number EMPL/ Employer Number NIDN: National Identify Number SOSE/ Social Security Number TXID: Tax Identification Number
PartyIdentifier string `json:"partyIdentifier,omitempty"`
// Name Format: Must begin with Line Code 1 followed by a slash and at least one valid non-space character: e.g., 1/SMITH JOHN.
Name string `json:"name,omitempty"`
// LineOne Format: Must begin with one of the following Line Codes followed by a slash and at least one valid non-space character. 1 Name 2 Address 3 Country and Town 4 Date of Birth 5 Place of Birth 6 Customer Identification Number 7 National Identity Number 8 Additional Information For example: 2/123 MAIN STREET 3/US/NEW YORK, NY 10000 7/111-22-3456
LineOne string `json:"lineOne,omitempty"`
// LineTwo Format: Must begin with one of the following Line Codes followed by a slash and at least one valid non-space character. 1 Name 2 Address 3 Country and Town 4 Date of Birth 5 Place of Birth 6 Customer Identification Number 7 National Identity Number 8 Additional Information For example: 2/123 MAIN STREET 3/US/NEW YORK, NY 10000 7/111-22-3456
LineTwo string `json:"lineTwo,omitempty"`
// LineThree Format: Must begin with one of the following Line Codes followed by a slash and at least one valid non-space character. 1 Name 2 Address 3 Country and Town 4 Date of Birth 5 Place of Birth 6 Customer Identification Number 7 National Identity Number 8 Additional Information For example: 2/123 MAIN STREET 3/US/NEW YORK, NY 10000 7/111-22-3456
LineThree string `json:"lineThree,omitempty"`
}
OptionF is originator option F
type OriginatorToBeneficiary ¶
type OriginatorToBeneficiary struct {
// LineOne
LineOne string `json:"lineOne,omitempty"`
// LineTwo
LineTwo string `json:"lineTwo,omitempty"`
// LineThree
LineThree string `json:"lineThree,omitempty"`
// LineFour
LineFour string `json:"lineFour,omitempty"`
}
OriginatorToBeneficiary
type OutputMessageAccountabilityData ¶
type OutputMessageAccountabilityData struct {
// OutputCycleDate (CCYYMMDD)
OutputCycleDate string `json:"outputCycleDate,omitempty"`
// OutputDestinationID
OutputDestinationID string `json:"outputDestinationID,omitempty"`
// OutputSequenceNumber
OutputSequenceNumber string `json:"outputSequenceNumber,omitempty"`
// Output Date MMDD, based on the calendar date
OutputDate string `json:"outputDate,omitempty"`
// Output Time HHMM, based on a 24-hour clock, Eastern Time
OutputTime string `json:"outputTime,omitempty"`
// OutputFRBApplicationIdentification
OutputFRBApplicationIdentification string `json:"outputFRBApplicationIdentification,omitempty"`
}
type PaymentNotification ¶
type PaymentNotification struct {
// Payment Notification Indicator * `0 - 6` - Reserved for market practice conventions. * `7 - 9` - Reserved for bilateral agreements between Fedwire senders and receivers.
PaymentNotificationIndicator string `json:"paymentNotificationIndicator,omitempty"`
// ContactNotificationElectronicAddress
ContactNotificationElectronicAddress string `json:"contactNotificationElectronicAddress,omitempty"`
// ContactName
ContactName string `json:"contactName,omitempty"`
// ContactPhoneNumber
ContactPhoneNumber string `json:"contactPhoneNumber,omitempty"`
// ContactMobileNumber
ContactMobileNumber string `json:"contactMobileNumber,omitempty"`
// FaxNumber
FaxNumber string `json:"faxNumber,omitempty"`
// EndToEndIdentification
EndToEndIdentification string `json:"endToEndIdentification,omitempty"`
}
PaymentNotification is the payment notification
type Personal ¶
type Personal struct {
// Identification Code: * `1` - Passport Number * `2` - Tax Identification Number * `3` - Driver’s License Number * `4` - Alien Registration Number * `5` - Corporate Identification * `9` - Other Identification
IdentificationCode string `json:"identificationCode"`
// Identifier
Identifier string `json:"identifier"`
// Name
Name string `json:"name"`
Address Address `json:"address"`
}
Personal is personal demographic information
type PreviousMessageIdentifier ¶
type PreviousMessageIdentifier struct {
// PreviousMessageIdentifier
PreviousMessageIdentifier string `json:"previousMessageIdentifier,omitempty"`
}
The identifier for a previous message
type PrimaryRemittanceDocument ¶
type PrimaryRemittanceDocument struct {
// Document Type Code * `AROI` - Accounts Receivable Open Item * `BOLD` - Bill of Lading Shipping Notice * `CINV` - Commercial Invoice * `CMCN` - Commercial Contract * `CNFA` - Credit Note Related to Financial Adjustment * `CREN` - Credit Note * `DEBN` - Debit Note * `DISP` - Dispatch Advice * `DNFA` - Debit Note Related to Financial Adjustment HIRI Hire Invoice * `MSIN` - Metered Service Invoice * `PROP` - Proprietary Document Type * `PUOR` - Purchase Order * `SBIN` - Self Billed Invoice * `SOAC` - Statement of Account * `TSUT` - Trade Services Utility Transaction VCHR Voucher
DocumentTypeCode string `json:"documentTypeCode,omitempty"`
// ProprietaryDocumentTypeCode
ProprietaryDocumentTypeCode string `json:"proprietaryDocumentTypeCode,omitempty"`
// DocumentIdentificationNumber
DocumentIdentificationNumber string `json:"documentIdentificationNumber,omitempty"`
// Issuer
Issuer string `json:"issuer,omitempty"`
}
type ReceiptTimeStamp ¶
type ReceiptTimeStamp struct {
// ReceiptDate MMDD, based on the calendar date
ReceiptDate string `json:"receiptDate,omitempty"`
// ReceiptTime HHMM, based on a 24-hour clock, Eastern Time
ReceiptTime string `json:"receiptTime,omitempty"`
// ApplicationIdentification
ReceiptApplicationIdentification string `json:"receiptApplicationIdentification,omitempty"`
}
type ReceiverDepositoryInstitution ¶
type ReceiverDepositoryInstitution struct {
// ReceiverABANumber
ReceiverABANumber string `json:"receiverABANumber"`
// ReceiverShortName
ReceiverShortName string `json:"receiverShortName"`
}
ReceiverDepositoryInstitution is the receiver depository institution
type RelatedRemittance ¶
type RelatedRemittance struct {
// RemittanceIdentification
RemittanceIdentification string `json:"remittanceIdentification,omitempty"`
// RemittanceLocationMethod * `EDIC` - Electronic Data Interchange * `EMAL` - Email * `FAXI` - Fax * `POST` - Postal services * `SMS` - Short Message Service (text) * `URI` - Uniform Resource Identifier
RemittanceLocationMethod string `json:"remittanceLocationMethod,omitempty"`
// RemittanceLocationElectronicAddress (E-mail or URL address)
RemittanceLocationElectronicAddress string `json:"remittanceLocationElectronicAddress,omitempty"`
RemittanceData RemittanceData `json:"remittanceData,omitempty"`
}
RelatedRemittance
type RemittanceAmount ¶
type RemittanceAmount struct {
// CurrencyCode
CurrencyCode string `json:"currencyCode,omitempty"`
// Amount Must contain at least one numeric character and only one decimal period marker (e.g., $1,234.56 should be entered as 1234.56). Can have up to 5 numeric characters following the decimal period marker (e.g., 1234.56789). Amount must be greater than zero (i.e., at least .01).
Amount string `json:"amount,omitempty"`
}
RemittanceAmount
type RemittanceBeneficiary ¶
type RemittanceBeneficiary struct {
// IdentificationType * `OI` - Organization ID * `PI` - Private ID
IdentificationType string `json:"identificationType,omitempty"`
// IdentificationCode Organization Identification Codes * `BANK` - Bank Party Identification * `CUST` - Customer Number * `DUNS` - Data Universal Number System (Dun & Bradstreet) * `EMPL` - Employer Identification Number * `GS1G` - Global Location Number * `PROP` - Proprietary Identification Number * `SWBB` - SWIFT BIC or BEI * `TXID` - Tax Identification Number Private Identification Codes * `ARNU` - Alien Registration Number * `CCPT` - Passport Number * `CUST` - Customer Number * `DPOB` - Date & Place of Birth * `DRLC` - Driver’s License Number * `EMPL` - Employee Identification Number * `NIDN` - National Identity Number * `PROP` - Proprietary Identification Number * `SOSE` - Social Security Number * `TXID` - Tax Identification Number
IdentificationCode string `json:"identificationCode,omitempty"`
// IdentificationNumber
IdentificationNumber string `json:"identificationNumber,omitempty"`
// IdentificationNumberIssuer
IdentificationNumberIssuer string `json:"identificationNumberIssuer,omitempty"`
// DateBirthPlace
DateBirthPlace string `json:"dateBirthPlace,omitempty"`
RemittanceData RemittanceData `json:"remittanceData,omitempty"`
}
type RemittanceData ¶
type RemittanceData struct {
// Name
Name string `json:"name,omitempty"`
// AddressType * `ADDR` - Complete Postal Address * `BIZZ` - Business Address * `DLVY` - Delivery Address * `HOME` - Home Address * `MLTO` - Mail Address * `PBOX` - Post Office Box
AddressType string `json:"addressType,omitempty"`
// Department
Department string `json:"department,omitempty"`
// SubDepartment
SubDepartment string `json:"subDepartment,omitempty"`
// StreetName
StreetName string `json:"streetName,omitempty"`
// BuildingNumber
BuildingNumber string `json:"buildingNumber,omitempty"`
// PostCode
PostCode string `json:"postCode,omitempty"`
// TownName
TownName string `json:"townName,omitempty"`
// CountrySubDivisionState
CountrySubDivisionState string `json:"countrySubDivisionState,omitempty"`
// Country
Country string `json:"country,omitempty"`
// AddressLineOne
AddressLineOne string `json:"addressLineOne,omitempty"`
// AddressLineTwo
AddressLineTwo string `json:"addressLineTwo,omitempty"`
// AddressLineThree
AddressLineThree string `json:"addressLineThree,omitempty"`
// AddressLineFour
AddressLineFour string `json:"addressLineFour,omitempty"`
// AddressLineFive
AddressLineFive string `json:"addressLineFive,omitempty"`
// AddressLineSix
AddressLineSix string `json:"addressLineSix,omitempty"`
// AddressLineSeven
AddressLineSeven string `json:"addressLineSeven,omitempty"`
// CountryOfResidence
CountryOfResidence string `json:"countryOfResidence,omitempty"`
}
type RemittanceFreeText ¶
type RemittanceOriginator ¶
type RemittanceOriginator struct {
// Identification Type * `OI` - Organization ID * `PI` - Private ID
IdentificationType string `json:"identificationType,omitempty"`
// IdentificationCode Organization Identification Codes * `BANK` - Bank Party Identification * `CUST` - Customer Number * `DUNS` - Data Universal Number System (Dun & Bradstreet) * `EMPL` - Employer Identification Number * `GS1G` - Global Location Number * `PROP` - Proprietary Identification Number * `SWBB` - SWIFT BIC or BEI * `TXID` - Tax Identification Number Private Identification Codes * `ARNU` - Alien Registration Number * `CCPT` - Passport Number * `CUST` - Customer Number * `DPOB` - Date & Place of Birth * `DRLC` - Driver’s License Number * `EMPL` - Employee Identification Number * `NIDN` - National Identity Number * `PROP` - Proprietary Identification Number * `SOSE` - Social Security Number * `TXID` - Tax Identification Number
IdentificationCode string `json:"identificationCode,omitempty"`
// IdentificationNumber
IdentificationNumber string `json:"identificationNumber,omitempty"`
// IdentificationNumberIssuer
IdentificationNumberIssuer string `json:"identificationNumberIssuer,omitempty"`
// DateBirthPlace
DateBirthPlace string `json:"dateBirthPlace,omitempty"`
RemittanceData RemittanceData `json:"remittanceData,omitempty"`
// CountryOfResidence
CountryOfResidence string `json:"countryOfResidence,omitempty"`
// ContactName
ContactName string `json:"contactName,omitempty"`
// ContactPhoneNumber
ContactPhoneNumber string `json:"contactPhoneNumber,omitempty"`
// ContactMobileNumber
ContactMobileNumber string `json:"contactMobileNumber,omitempty"`
// ContactFaxNumber
ContactFaxNumber string `json:"contactFaxNumber,omitempty"`
// ContactElectronicAddress ( i.e., E-mail or URL address)
ContactElectronicAddress string `json:"contactElectronicAddress,omitempty"`
// ContactOther
ContactOther string `json:"contactOther,omitempty"`
}
RemittanceOriginator
type SecondaryRemittanceDocument ¶
type SecondaryRemittanceDocument struct {
// Document Type Code * `AROI` - Accounts Receivable Open Item * `DISP` - Dispatch Advice * `FXDR` - Foreign Exchange Deal Reference * `PROP` - Proprietary Document Type PUOR Purchase Order * `RADM` - Remittance Advice Message * `RPIN` - Related Payment Instruction * `SCOR1` - Structured Communication Reference VCHR Voucher
DocumentTypeCode string `json:"documentTypeCode,omitempty"`
// proprietaryDocumentTypeCode
ProprietaryDocumentTypeCode string `json:"proprietaryDocumentTypeCode,omitempty"`
// documentIdentificationNumber
DocumentIdentificationNumber string `json:"documentIdentificationNumber,omitempty"`
// Issuer
Issuer string `json:"issuer,omitempty"`
}
SecondaryRemittanceDocument
type SenderDepositoryInstitution ¶
type SenderDepositoryInstitution struct {
// SenderABANumber
SenderABANumber string `json:"senderABANumber"`
// SenderShortName
SenderShortName string `json:"senderShortName"`
}
SenderDepositoryInstitution is the receiver depository institution
type SenderReference ¶
type SenderReference struct {
// SenderReference
SenderReference string `json:"senderReference,omitempty"`
}
SenderReference is sender reference
type SenderSupplied ¶
type SenderSupplied struct {
// FormatVersion 30
FormatVersion string `json:"formatVersion"`
// UserRequestCorrelation
UserRequestCorrelation string `json:"userRequestCorrelation"`
// Identifies if test or production. * `T` - Test * `P` - Production
TestProductionCode string `json:"testProductionCode"`
// MessageDuplicationCode * ` ` - Original Message * `R` - Retrieval of an original message * `P` - Resend
MessageDuplicationCode string `json:"messageDuplicationCode"`
}
SenderSupplied
type ServiceMessage ¶
type ServiceMessage struct {
// LineOne
LineOne string `json:"lineOne,omitempty"`
// LineTwo
LineTwo string `json:"lineTwo,omitempty"`
// LineThree
LineThree string `json:"lineThree,omitempty"`
// LineFour
LineFour string `json:"lineFour,omitempty"`
// LineFive
LineFive string `json:"lineFive,omitempty"`
// LineSix
LineSix string `json:"lineSix,omitempty"`
// LineSeven
LineSeven string `json:"lineSeven,omitempty"`
// LineEight
LineEight string `json:"lineEight,omitempty"`
// LineNine
LineNine string `json:"lineNine,omitempty"`
// LineTen
LineTen string `json:"lineTen,omitempty"`
// LineEleven
LineEleven string `json:"lineEleven,omitempty"`
// LineTwelve
LineTwelve string `json:"lineTwelve,omitempty"`
}
type TypeSubType ¶
type TypeSubType struct {
// TypeCode: * `10` - Funds Transfer - A funds transfer in which the sender and/or receiver may be a bank or a third party (i.e., customer of a bank). * `15` - Foreign Transfer - A funds transfer to or from a foreign central bank or government or international organization with an account at the Federal Reserve Bank of New York. * `16` - Settlement Transfer - A funds transfer between Fedwire Funds Service participants.
TypeCode string `json:"typeCode"`
// SubTypeCode: * `00` - Basic Funds Transfer - A basic value funds transfer. * `01` - Request for Reversal - A non-value request for reversal of a funds transfer originated on the current business day. * `02` - Reversal of Transfer - A value reversal of a funds transfer received on the current business day. May be used in response to a subtype code ‘01’ Request for Reversal. * `07` - Request for Reversal of a Prior Day Transfer - A non-value request for a reversal of a funds transfer originated on a prior business day. * `08` - Reversal of a Prior Day Transfer - A value reversal of a funds transfer received on a prior business day. May be used in response to a subtype code ‘07’ Request for Reversal of a Prior Day Transfer. * `31` - Request for Credit (Drawdown) - A non-value request for the receiver to send a funds transfer to a designated party. * `32` - Funds Transfer Honoring a Request for Credit (Drawdown) - A value funds transfer honoring a subtype 31 request for credit. * `33` -Refusal to Honor a Request for Credit (Drawdown) - A non-value message indicating refusal to honor a subtype 31 request for credit. * `90` - Service Message - A non-value message used to communicate questions and information that is not covered by a specific subtype.
SubTypeCode string `json:"subTypeCode"`
}
TypeSubtype is the type and sub type codes
type UnstructuredAddenda ¶
type UnstructuredAddenda struct {
// AddendaLength Addenda Length must be numeric, padded with leading zeros if less than four characters and must equal length of content in Addenda Information (e.g., if content of Addenda Information is 987 characters, Addenda Length must be 0987).
AddendaLength string `json:"addendaLength,omitempty"`
// Addenda
Addenda string `json:"addenda,omitempty"`
}
type UpdateWireFileByIDOpts ¶
type ValidateWireFileOpts ¶
type WireFilesApiService ¶
type WireFilesApiService service
func (*WireFilesApiService) CreateWireFile ¶
func (a *WireFilesApiService) CreateWireFile(ctx context.Context, createFile CreateFile, localVarOptionals *CreateWireFileOpts) (File, *http.Response, error)
func (*WireFilesApiService) DeleteWireFileByID ¶
func (a *WireFilesApiService) DeleteWireFileByID(ctx context.Context, fileID string, localVarOptionals *DeleteWireFileByIDOpts) (*http.Response, error)
func (*WireFilesApiService) GetWireFileByID ¶ added in v0.2.0
func (a *WireFilesApiService) GetWireFileByID(ctx context.Context, fileID string, localVarOptionals *GetWireFileByIDOpts) (File, *http.Response, error)
func (*WireFilesApiService) GetWireFileContents ¶
func (a *WireFilesApiService) GetWireFileContents(ctx context.Context, fileID string, localVarOptionals *GetWireFileContentsOpts) (string, *http.Response, error)
func (*WireFilesApiService) GetWireFiles ¶
func (a *WireFilesApiService) GetWireFiles(ctx context.Context, localVarOptionals *GetWireFilesOpts) ([]File, *http.Response, error)
func (*WireFilesApiService) Ping ¶ added in v0.2.0
WireFilesApiService Ping the Wire service to check if running
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
func (*WireFilesApiService) UpdateWireFileByID ¶
func (a *WireFilesApiService) UpdateWireFileByID(ctx context.Context, fileID string, createFile CreateFile, localVarOptionals *UpdateWireFileByIDOpts) (File, *http.Response, error)
func (*WireFilesApiService) ValidateWireFile ¶
func (a *WireFilesApiService) ValidateWireFile(ctx context.Context, fileID string, localVarOptionals *ValidateWireFileOpts) (File, *http.Response, error)
Source Files
¶
- api_fed_wire_message_file.go
- api_wire_files.go
- client.go
- configuration.go
- model_account_credited_drawdown.go
- model_account_debited_drawdown.go
- model_additional_fi_to_fi.go
- model_address.go
- model_adjustment.go
- model_advice.go
- model_amount.go
- model_beneficiary_reference.go
- model_business_function_code.go
- model_charges.go
- model_cover_payment.go
- model_create_file.go
- model_currency_instructed_amount.go
- model_date_remittance_document.go
- model_error.go
- model_error_wire.go
- model_exchange_rate.go
- model_fed_wire_message.go
- model_fi_payment_method_to_beneficiary.go
- model_fi_to_fi.go
- model_file.go
- model_financial_institution.go
- model_input_message_accountability_data.go
- model_instructed_amount.go
- model_local_instrument.go
- model_message_disposition.go
- model_originator_option_f.go
- model_originator_to_beneficiary.go
- model_output_message_accountability_data.go
- model_payment_notification.go
- model_personal.go
- model_previous_message_identifier.go
- model_primary_remittance_document.go
- model_receipt_time_stamp.go
- model_receiver_depository_institution.go
- model_related_remittance.go
- model_remittance_amount.go
- model_remittance_beneficiary.go
- model_remittance_data.go
- model_remittance_free_text.go
- model_remittance_originator.go
- model_secondary_remittance_document.go
- model_sender_depository_institution.go
- model_sender_reference.go
- model_sender_supplied.go
- model_service_message.go
- model_type_sub_type.go
- model_unstructured_addenda.go
- response.go