openapi

type APIClient struct {
	WireFilesApi *WireFilesApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

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:"-"`
}

type AccountCreditedDrawdown struct {
	// DrawdownCreditAccountNumber  9 character ABA
	DrawdownCreditAccountNumber string `json:"drawdownCreditAccountNumber,omitempty"`
}

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"`
}

type AddFEDWireMessageToFileOpts struct {
	XRequestID optional.String
}

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 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"`
}

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"`
}

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type Beneficiary struct {
	Personal Personal `json:"personal"`
}

type BeneficiaryReference struct {
	// BeneficiaryReference
	BeneficiaryReference string `json:"beneficiaryReference,omitempty"`
}

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"`
}

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 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
}

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"`
}

type CreateWireFileOpts struct {
	XRequestID                 optional.String
	SkipMandatoryIMAD          optional.Bool
	AllowMissingSenderSupplied optional.Bool
}

type CurrencyInstructedAmount struct {
	// SwiftFieldTag
	SwiftFieldTag string `json:"swiftFieldTag,omitempty"`
	// Amount
	Amount string `json:"amount,omitempty"`
}

type DateRemittanceDocument struct {
	// DateRemittanceDocument (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day)
	DateRemittanceDocument string `json:"dateRemittanceDocument,omitempty"`
}

type DeleteWireFileByIDOpts struct {
	XRequestID optional.String
}

type Error struct {
	// An error message describing the problem intended for humans.
	Error string `json:"error"`
}

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"`
}

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"`
}

type FedWireMessage struct {
	// Fedwire Message 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                          WireAmount                      `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                     Beneficiary                     `json:"beneficiary,omitempty"`
	BeneficiaryReference            BeneficiaryReference            `json:"beneficiaryReference,omitempty"`
	AccountDebitedDrawdown          AccountDebitedDrawdown          `json:"accountDebitedDrawdown,omitempty"`
	Originator                      Beneficiary                     `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"`
	ValidateOptions                 *ValidateOptions                `json:"validateOptions,omitempty"`
}

type FiPaymentMethodToBeneficiary struct {
	// PaymentMethod
	PaymentMethod         string `json:"paymentMethod,omitempty"`
	AdditionalInformation string `json:"AdditionalInformation,omitempty"`
}

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"`
}

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 WireAddress `json:"address"`
}

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

type GetWireFileByIDOpts struct {
	XRequestID optional.String
}

type GetWireFileContentsOpts struct {
	XRequestID optional.String
	Format     optional.String
	Newline    optional.Bool
}

type GetWireFilesOpts struct {
	XRequestID optional.String
}

type InputMessageAccountabilityData struct {
	// InputCycleDate (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day)
	InputCycleDate string `json:"inputCycleDate"`
	// InputSource
	InputSource string `json:"inputSource"`
	// InputSequenceNumber
	InputSequenceNumber string `json:"inputSequenceNumber"`
}

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 0,99).
	Amount string `json:"amount,omitempty"`
}

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"`
}

type MessageDisposition struct {
	// formatVersion identifies the Fedwire message 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 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"`
}

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"`
}

type OutputMessageAccountabilityData struct {
	// OutputCycleDate (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day)
	OutputCycleDate string `json:"outputCycleDate,omitempty"`
	// OutputDestinationID
	OutputDestinationID string `json:"outputDestinationID,omitempty"`
	// OutputSequenceNumber
	OutputSequenceNumber string `json:"outputSequenceNumber,omitempty"`
	// Output Date is based on the calendar date. (Format MMDD - M=Month, D=Day)
	OutputDate string `json:"outputDate,omitempty"`
	// Output Time is based on a 24-hour clock, Eastern Time. (Format HHmm - H=Hour, m=Minute)
	OutputTime string `json:"outputTime,omitempty"`
	// OutputFRBApplicationIdentification
	OutputFRBApplicationIdentification string `json:"outputFRBApplicationIdentification,omitempty"`
}

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"`
}

type Personal 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 * `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 WireAddress `json:"address"`
}

type PreviousMessageIdentifier struct {
	// PreviousMessageIdentifier
	PreviousMessageIdentifier string `json:"previousMessageIdentifier,omitempty"`
}

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 struct {
	// ReceiptDate is based on the calendar date. (Format MMDD - M=Month, D=Day)
	ReceiptDate string `json:"receiptDate,omitempty"`
	// ReceiptTime is based on a 24-hour clock, Eastern Time. (Format HHmm - H=Hour, m=Minute)
	ReceiptTime string `json:"receiptTime,omitempty"`
	// ApplicationIdentification
	ReceiptApplicationIdentification string `json:"receiptApplicationIdentification,omitempty"`
}

type ReceiverDepositoryInstitution struct {
	// ReceiverABANumber
	ReceiverABANumber string `json:"receiverABANumber"`
	// ReceiverShortName
	ReceiverShortName string `json:"receiverShortName"`
}

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"`
}

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 five 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"`
}

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 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 struct {
	// LineOne
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree
	LineThree string `json:"lineThree,omitempty"`
}

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"`
}

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"`
}

type SenderDepositoryInstitution struct {
	// SenderABANumber
	SenderABANumber string `json:"senderABANumber"`
	// SenderShortName
	SenderShortName string `json:"senderShortName"`
}

type SenderReference struct {
	// SenderReference
	SenderReference string `json:"senderReference,omitempty"`
}

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"`
}

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 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"`
}

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 ValidateOptions struct {
	// Skip validation of the InputMessageAccountabilityData (IMAD) field
	SkipMandatoryIMAD bool `json:"skipMandatoryIMAD,omitempty"`
	// Allow FedWireMessage.SenderSupplied to be nil
	AllowMissingSenderSupplied bool `json:"allowMissingSenderSupplied,omitempty"`
}

type ValidateWireFileOpts struct {
	XRequestID optional.String
}

type WireAddress struct {
	// AddressLineOne
	AddressLineOne string `json:"addressLineOne,omitempty"`
	// AddressLineTwo
	AddressLineTwo string `json:"addressLineTwo,omitempty"`
	// AddressLineThree
	AddressLineThree string `json:"addressLineThree,omitempty"`
}

type WireAmount struct {
	// Amount is 12 numeric digits, right-justified with leading zeros. It has 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"`
}

type WireFile struct {
	// File ID
	ID             string         `json:"ID,omitempty"`
	FedWireMessage FedWireMessage `json:"fedWireMessage"`
}

type WireFilesApiService service