--- title: "Retrieve file" method: GET path: "/files/{fileID}" tags: ["Wire Files"] --- # Retrieve file `GET /files/{fileID}` Get the details of an existing File using the unique File identifier that was returned upon creation. ## Path parameters - `fileID` string, required ## Headers - `X-Request-ID` string ## Response `200` A File object for the supplied ID - WireFile - `ID` string — File ID - `fedWireMessage` FEDWireMessage, required - `ID` string — Fedwire Message ID - `messageDisposition` MessageDisposition - `formatVersion` string — formatVersion identifies the Fedwire message format version 30. - `testProductionCode` ' ' | 'T' | 'P' — testProductionCode identifies if test or production. * `T` - Test * `P` - Production - `messageDuplicationCode` ' ' | 'R' | 'P' — MessageDuplicationCode * ` ` - Original Message * `R` - Retrieval of an original message * `P` - Resend - `messageStatusIndicator` '0' | '2' | '3' | '7' | 'N' | 'S' — 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) - `receiptTimeStamp` ReceiptTimeStamp - `receiptDate` string, MMDD — ReceiptDate is based on the calendar date. (Format MMDD - M=Month, D=Day) - `receiptTime` string, HHmm — ReceiptTime is based on a 24-hour clock, Eastern Time. (Format HHmm - H=Hour, m=Minute) - `receiptApplicationIdentification` string — ApplicationIdentification - `outputMessageAccountabilityData` OutputMessageAccountabilityData - `outputCycleDate` string, CCYYMMDD — OutputCycleDate (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day) - `outputDestinationID` string — OutputDestinationID - `outputSequenceNumber` string — OutputSequenceNumber - `outputDate` string, MMDD — Output Date is based on the calendar date. (Format MMDD - M=Month, D=Day) - `outputTime` string, HHmm — Output Time is based on a 24-hour clock, Eastern Time. (Format HHmm - H=Hour, m=Minute) - `outputFRBApplicationIdentification` string — OutputFRBApplicationIdentification - `errorWire` ErrorWire - `errorCategory` 'E' | 'F' | 'H' | 'I' | 'W' | 'X' — ErrorCategory * `E` - Data Error * `F` - Insufficient Balance * `H` - Accountability Error * `I` - In Process or Intercepted * `W` - Cutoff Hour Error * `X` - Duplicate IMAD - `errorCode` string — ErrorCode - `errorDescription` string — ErrorDescription - `senderSupplied` SenderSupplied, required - `formatVersion` string, required — FormatVersion 30 - `userRequestCorrelation` string, required — UserRequestCorrelation - `testProductionCode` 'T' | 'P', required — Identifies if test or production. * `T` - Test * `P` - Production - `messageDuplicationCode` ' ' | 'R' | 'P', required — MessageDuplicationCode * ` ` - Original Message * `R` - Retrieval of an original message * `P` - Resend - `typeSubType` TypeSubType, required - `typeCode` '10' | '15' | '16', required — 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. - `subTypeCode` '00' | '01' | '02' | '07' | '08' | '31' | '32' | '33' | '90', required — 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. - `inputMessageAccountabilityData` InputMessageAccountabilityData, required - `inputCycleDate` string, CCYYMMDD, required — InputCycleDate (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day) - `inputSource` string, required — InputSource - `inputSequenceNumber` string, required — InputSequenceNumber - `amount` WireAmount, required — Maximum amount is a penny less than $10 billion. - `amount` string, required — 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. - `senderDepositoryInstitution` SenderDepositoryInstitution, required — SenderDepositoryInstitution is the receiver depository institution - `senderABANumber` string, required — SenderABANumber - `senderShortName` string, required — SenderShortName - `receiverDepositoryInstitution` ReceiverDepositoryInstitution, required — ReceiverDepositoryInstitution is the receiver depository institution. - `receiverABANumber` string, required — ReceiverABANumber - `receiverShortName` string, required — ReceiverShortName - `businessFunctionCode` BusinessFunctionCode, required - `businessFunctionCode` 'BTR' | 'DRC' | 'CKS' | 'DRW' | 'CTP' | 'FFR' | 'CTR' | 'FFS' | 'DEP' | 'SVC' | 'DRB', required — 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 - `transactionTypeCode` string — TransactionTypeCode If {3600} is CTR, an optional Transaction Type Code element is permitted; however, the Transaction Type Code 'COV' is not permitted. - `senderReference` SenderReference - `senderReference` string — SenderReference - `previousMessageIdentifier` PreviousMessageIdentifier — The identifier for a previous message. - `previousMessageIdentifier` string — PreviousMessageIdentifier - `localInstrument` LocalInstrument - `localInstrumentCode` 'ANSI' | 'COVS' | 'GXML' | 'IXML' | 'NARR' | 'PROP' | 'RMTS' | 'RRMT' | 'S820' | 'SWIF' | 'UEDI' — 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 - `proprietaryCode` string — ProprietaryCode - `paymentNotification` PaymentNotification - `paymentNotificationIndicator` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' — Payment Notification Indicator * `0 - 6` - Reserved for market practice conventions. * `7 - 9` - Reserved for bilateral agreements between Fedwire senders and receivers. - `contactNotificationElectronicAddress` string — ContactNotificationElectronicAddress - `contactName` string — ContactName - `contactPhoneNumber` string — ContactPhoneNumber - `contactMobileNumber` string — ContactMobileNumber - `faxNumber` string — FaxNumber - `endToEndIdentification` string — EndToEndIdentification - `charges` Charges - `chargeDetails` 'B' | 'S' — Charge Details * `B` - Beneficiary * `S` - Shared - `sendersChargesOne` string — 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. - `sendersChargesTwo` string — 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. - `sendersChargesThree` string — 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. - `sendersChargesFour` string — 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. - `instructedAmount` InstructedAmount - `currencyCode` string — CurrencyCode - `amount` string — 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). - `exchangeRate` ExchangeRate - `exchangeRate` string — 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). - `beneficiaryIntermediaryFI` FinancialInstitution — FinancialInstitution is financial institution demographic information. - `identificationCode` 'B' | 'C' | 'D' | 'F' | 'T' | 'U', required — 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 - `identifier` string, required — Identifier - `name` string, required — Name - `address` WireAddress, required — Identifies Address - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `beneficiaryFI` FinancialInstitution — FinancialInstitution is financial institution demographic information. - `identificationCode` 'B' | 'C' | 'D' | 'F' | 'T' | 'U', required — 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 - `identifier` string, required — Identifier - `name` string, required — Name - `address` WireAddress, required — Identifies Address - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `beneficiary` Beneficiary - `personal` Personal, required — Personal is personal demographic information. - `identificationCode` string, required — 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 - `identifier` string, required — Identifier - `name` string, required — Name - `address` WireAddress, required — Identifies Address - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `beneficiaryReference` BeneficiaryReference - `beneficiaryReference` string — BeneficiaryReference - `accountDebitedDrawdown` AccountDebitedDrawdown — AccountDebitedDrawdown is the account which is debited in a drawdown. - `identificationCode` 'D', required — Identification Code * `D` - Debit - `identifier` string, required — Identifier - `name` string, required — Name - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `originator` Beneficiary - `personal` Personal, required — Personal is personal demographic information. - `identificationCode` string, required — 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 - `identifier` string, required — Identifier - `name` string, required — Name - `address` WireAddress, required — Identifies Address - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `originatorOptionF` OriginatorOptionF - `partyIdentifier` string — 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 - `name` string — 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). - `lineOne` string — 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` - `lineTwo` string — 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` - `lineThree` string — 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` - `originatorFI` FinancialInstitution — FinancialInstitution is financial institution demographic information. - `identificationCode` 'B' | 'C' | 'D' | 'F' | 'T' | 'U', required — 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 - `identifier` string, required — Identifier - `name` string, required — Name - `address` WireAddress, required — Identifies Address - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `instructingFI` FinancialInstitution — FinancialInstitution is financial institution demographic information. - `identificationCode` 'B' | 'C' | 'D' | 'F' | 'T' | 'U', required — 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 - `identifier` string, required — Identifier - `name` string, required — Name - `address` WireAddress, required — Identifies Address - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `accountCreditedDrawdown` AccountCreditedDrawdown — AccountCreditedDrawdown is the account which is credited in a drawdown. - `drawdownCreditAccountNumber` string — DrawdownCreditAccountNumber 9 character ABA - `originatorToBeneficiary` OriginatorToBeneficiary - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `fiReceiverFI` FIToFI - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiDrawdownDebitAccountAdvice` Advice - `adviceCode` 'HLD' | 'LTR' | 'PHN' | 'TLX' | 'WRE' — Advice Code * `HLD` - Hold * `LTR` - Letter * `PHN` - Phone * `TLX` - Telex * `WRE` - Wire - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiIntermediaryFI` FIToFI - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiIntermediaryFIAdvice` Advice - `adviceCode` 'HLD' | 'LTR' | 'PHN' | 'TLX' | 'WRE' — Advice Code * `HLD` - Hold * `LTR` - Letter * `PHN` - Phone * `TLX` - Telex * `WRE` - Wire - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiBeneficiaryFI` FIToFI - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiBeneficiaryFIAdvice` Advice - `adviceCode` 'HLD' | 'LTR' | 'PHN' | 'TLX' | 'WRE' — Advice Code * `HLD` - Hold * `LTR` - Letter * `PHN` - Phone * `TLX` - Telex * `WRE` - Wire - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiBeneficiary` FIToFI - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiBeneficiaryAdvice` Advice - `adviceCode` 'HLD' | 'LTR' | 'PHN' | 'TLX' | 'WRE' — Advice Code * `HLD` - Hold * `LTR` - Letter * `PHN` - Phone * `TLX` - Telex * `WRE` - Wire - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `fiPaymentMethodToBeneficiary` FIPaymentMethodToBeneficiary - `paymentMethod` 'CHECK' — PaymentMethod - `AdditionalInformation` string - `fiAdditionalFIToFI` AdditionalFIToFI - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `currencyInstructedAmount` CurrencyInstructedAmount - `swiftFieldTag` string — SwiftFieldTag - `amount` string — Amount - `orderingCustomer` CoverPayment - `swiftFieldTag` string — SwiftFieldTag - `swiftLineOne` string — SwiftLineOne - `swiftLineTwo` string — SwiftLineTwo - `swiftLineThree` string — SwiftLineThree - `swiftLineFour` string — SwiftLineFour - `swiftLineFive` string — SwiftLineFive - `swiftLineSix` string — SwiftLineSix - `orderingInstitution` CoverPayment - `swiftFieldTag` string — SwiftFieldTag - `swiftLineOne` string — SwiftLineOne - `swiftLineTwo` string — SwiftLineTwo - `swiftLineThree` string — SwiftLineThree - `swiftLineFour` string — SwiftLineFour - `swiftLineFive` string — SwiftLineFive - `swiftLineSix` string — SwiftLineSix - `intermediaryInstitution` CoverPayment - `swiftFieldTag` string — SwiftFieldTag - `swiftLineOne` string — SwiftLineOne - `swiftLineTwo` string — SwiftLineTwo - `swiftLineThree` string — SwiftLineThree - `swiftLineFour` string — SwiftLineFour - `swiftLineFive` string — SwiftLineFive - `swiftLineSix` string — SwiftLineSix - `institutionAccount` CoverPayment - `swiftFieldTag` string — SwiftFieldTag - `swiftLineOne` string — SwiftLineOne - `swiftLineTwo` string — SwiftLineTwo - `swiftLineThree` string — SwiftLineThree - `swiftLineFour` string — SwiftLineFour - `swiftLineFive` string — SwiftLineFive - `swiftLineSix` string — SwiftLineSix - `beneficiaryCustomer` CoverPayment - `swiftFieldTag` string — SwiftFieldTag - `swiftLineOne` string — SwiftLineOne - `swiftLineTwo` string — SwiftLineTwo - `swiftLineThree` string — SwiftLineThree - `swiftLineFour` string — SwiftLineFour - `swiftLineFive` string — SwiftLineFive - `swiftLineSix` string — SwiftLineSix - `remittance` CoverPayment - `swiftFieldTag` string — SwiftFieldTag - `swiftLineOne` string — SwiftLineOne - `swiftLineTwo` string — SwiftLineTwo - `swiftLineThree` string — SwiftLineThree - `swiftLineFour` string — SwiftLineFour - `swiftLineFive` string — SwiftLineFive - `swiftLineSix` string — SwiftLineSix - `senderToReceiver` CoverPayment - `swiftFieldTag` string — SwiftFieldTag - `swiftLineOne` string — SwiftLineOne - `swiftLineTwo` string — SwiftLineTwo - `swiftLineThree` string — SwiftLineThree - `swiftLineFour` string — SwiftLineFour - `swiftLineFive` string — SwiftLineFive - `swiftLineSix` string — SwiftLineSix - `unstructuredAddenda` UnstructuredAddenda - `addendaLength` string — 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). - `addenda` string — Addenda - `relatedRemittance` RelatedRemittance - `remittanceIdentification` string — RemittanceIdentification - `remittanceLocationMethod` 'EDIC' | 'EMAL' | 'FAXI' | 'POST' | 'SMS' | 'URI' — RemittanceLocationMethod * `EDIC` - Electronic Data Interchange * `EMAL` - Email * `FAXI` - Fax * `POST` - Postal services * `SMS` - Short Message Service (text) * `URI` - Uniform Resource Identifier - `remittanceLocationElectronicAddress` string — RemittanceLocationElectronicAddress (E-mail or URL address) - `remittanceData` RemittanceData - `name` string — Name - `addressType` 'ADDR' | 'BIZZ' | 'DLVY' | 'HOME' | 'MLTO' | 'PBOX' — AddressType * `ADDR` - Complete Postal Address * `BIZZ` - Business Address * `DLVY` - Delivery Address * `HOME` - Home Address * `MLTO` - Mail Address * `PBOX` - Post Office Box - `department` string — Department - `subDepartment` string — SubDepartment - `streetName` string — StreetName - `buildingNumber` string — BuildingNumber - `postCode` string — PostCode - `townName` string — TownName - `countrySubDivisionState` string — CountrySubDivisionState - `country` string — Country - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `addressLineFour` string — AddressLineFour - `addressLineFive` string — AddressLineFive - `addressLineSix` string — AddressLineSix - `addressLineSeven` string — AddressLineSeven - `countryOfResidence` string — CountryOfResidence - `remittanceOriginator` RemittanceOriginator - `identificationType` 'OI' | 'PI' — Identification Type * `OI` - Organization ID * `PI` - Private ID - `identificationCode` string — 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 - `identificationNumber` string — IdentificationNumber - `identificationNumberIssuer` string — IdentificationNumberIssuer - `dateBirthPlace` string — DateBirthPlace - `remittanceData` RemittanceData - `name` string — Name - `addressType` 'ADDR' | 'BIZZ' | 'DLVY' | 'HOME' | 'MLTO' | 'PBOX' — AddressType * `ADDR` - Complete Postal Address * `BIZZ` - Business Address * `DLVY` - Delivery Address * `HOME` - Home Address * `MLTO` - Mail Address * `PBOX` - Post Office Box - `department` string — Department - `subDepartment` string — SubDepartment - `streetName` string — StreetName - `buildingNumber` string — BuildingNumber - `postCode` string — PostCode - `townName` string — TownName - `countrySubDivisionState` string — CountrySubDivisionState - `country` string — Country - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `addressLineFour` string — AddressLineFour - `addressLineFive` string — AddressLineFive - `addressLineSix` string — AddressLineSix - `addressLineSeven` string — AddressLineSeven - `countryOfResidence` string — CountryOfResidence - `countryOfResidence` string — CountryOfResidence - `contactName` string — ContactName - `contactPhoneNumber` string — ContactPhoneNumber - `contactMobileNumber` string — ContactMobileNumber - `contactFaxNumber` string — ContactFaxNumber - `contactElectronicAddress` string — ContactElectronicAddress (i.e., E-mail or URL address) - `contactOther` string — ContactOther - `remittanceBeneficiary` RemittanceBeneficiary - `identificationType` 'OI' | 'PI' — IdentificationType * `OI` - Organization ID * `PI` - Private ID - `identificationCode` string — 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 - `identificationNumber` string — IdentificationNumber - `identificationNumberIssuer` string — IdentificationNumberIssuer - `dateBirthPlace` string — DateBirthPlace - `remittanceData` RemittanceData - `name` string — Name - `addressType` 'ADDR' | 'BIZZ' | 'DLVY' | 'HOME' | 'MLTO' | 'PBOX' — AddressType * `ADDR` - Complete Postal Address * `BIZZ` - Business Address * `DLVY` - Delivery Address * `HOME` - Home Address * `MLTO` - Mail Address * `PBOX` - Post Office Box - `department` string — Department - `subDepartment` string — SubDepartment - `streetName` string — StreetName - `buildingNumber` string — BuildingNumber - `postCode` string — PostCode - `townName` string — TownName - `countrySubDivisionState` string — CountrySubDivisionState - `country` string — Country - `addressLineOne` string — AddressLineOne - `addressLineTwo` string — AddressLineTwo - `addressLineThree` string — AddressLineThree - `addressLineFour` string — AddressLineFour - `addressLineFive` string — AddressLineFive - `addressLineSix` string — AddressLineSix - `addressLineSeven` string — AddressLineSeven - `countryOfResidence` string — CountryOfResidence - `primaryRemittanceDocument` PrimaryRemittanceDocument - `documentTypeCode` 'AROI' | 'BOLD' | 'CINV' | 'CMCN' | 'CNFA' | 'CREN' | 'DEBN' | 'DISP' | 'DNFA' | 'MSIN' | 'PROP' | 'PUOR' | 'SBIN' | 'SOAC' | 'TSUT' — 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 - `proprietaryDocumentTypeCode` string — ProprietaryDocumentTypeCode - `documentIdentificationNumber` string — DocumentIdentificationNumber - `issuer` string — Issuer - `actualAmountPaid` RemittanceAmount - `currencyCode` string — CurrencyCode - `amount` string — 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). - `grossAmountRemittanceDocument` RemittanceAmount - `currencyCode` string — CurrencyCode - `amount` string — 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). - `amountNegotiatedDiscount` RemittanceAmount - `currencyCode` string — CurrencyCode - `amount` string — 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). - `adjustment` Adjustment - `adjustmentReasonCode` '01' | '03' | '04' | '05' | '06' | '11' | '12' | '59' | '75' | '81' | 'CM' — 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 - `creditDebitIndicator` 'CRDT' | 'DBIT' — CreditDebitIndicator * `CRDT` - Credit * `DBIT` - Debit - `currencyCode` string — CurrencyCode - `amount` string — 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). - `additionalInfo` string — AdditionalInfo - `dateRemittanceDocument` DateRemittanceDocument - `dateRemittanceDocument` string, CCYYMMDD — DateRemittanceDocument (Format CCYYMMDD - C=Century, Y=Year, M=Month, D=Day) - `secondaryRemittanceDocument` SecondaryRemittanceDocument - `documentTypeCode` 'AROI' | 'DISP' | 'FXDR' | 'PROP' | 'RADM' | 'RPIN' | 'SCOR1' — 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 - `proprietaryDocumentTypeCode` string — proprietaryDocumentTypeCode - `documentIdentificationNumber` string — documentIdentificationNumber - `issuer` string — Issuer - `remittanceFreeText` RemittanceFreeText - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `serviceMessage` ServiceMessage - `lineOne` string — LineOne - `lineTwo` string — LineTwo - `lineThree` string — LineThree - `lineFour` string — LineFour - `lineFive` string — LineFive - `lineSix` string — LineSix - `lineSeven` string — LineSeven - `lineEight` string — LineEight - `lineNine` string — LineNine - `lineTen` string — LineTen - `lineEleven` string — LineEleven - `lineTwelve` string — LineTwelve - `validateOptions` ValidateOptions, nullable - `skipMandatoryIMAD` boolean — Skip validation of the InputMessageAccountabilityData (IMAD) field - `allowMissingSenderSupplied` boolean — Allow FedWireMessage.SenderSupplied to be nil ## Other responses - `404` — A resource with the specified ID was not found ## Changes > 52 revisions in range; 38 could not be searched. - **2019-03-27** `7e3e24800c15` — 7 breaking, 57 warning, 5 info - removed the required property `fedWireMessage/amount` from the response with the `200` status - removed the required property `fedWireMessage/businessFunctionCode` from the response with the `200` status - removed the required property `fedWireMessage/inputMessageAccountabilityData` from the response with the `200` status - removed the required property `fedWireMessage/receiverDepositoryInstitution` from the response with the `200` status - …65 more [Change history](https://skmtc.dev/moov-io/apis/wire-api/changes/files/:fileID/get.md) --- [API](https://skmtc.dev/moov-io/apis/wire-api.md) · [All operations](https://skmtc.dev/moov-io/apis/wire-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/moov-io/wire-api/revisions/9edefe9f84bb/schema)