Wire Files
Add FEDWireMessage to File
Add a FEDWireMessage to the specified file
post/files/{fileID}/FEDWireMessage
Path parameters
fileIDstring required
Example:3f2d23ee214
File ID
Headers
X-Request-IDstring
Optional Request ID allows application developer to trace requests through the systems logs
X-Idempotency-Keystring
Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests.
Request body
Example request
{
"ID": "3f2d23ee214",
"messageDisposition": {
"formatVersion": "30",
"testProductionCode": "T"
},
"receiptTimeStamp": {
"receiptDate": "0401",
"receiptTime": "1305",
"receiptApplicationIdentification": "RB11"
},
"outputMessageAccountabilityData": {
"outputCycleDate": "20190401",
"outputDestinationID": "12345678",
"outputSequenceNumber": "000001",
"outputDate": "0401",
"outputTime": "1305",
"outputFRBApplicationIdentification": "OB11"
},
"errorWire": {
"errorCategory": "E",
"errorCode": "E99",
"errorDescription": "Data Error"
},
"senderSupplied": {
"formatVersion": "30",
"userRequestCorrelation": "TESTDATA",
"testProductionCode": "T",
"messageDuplicationCode": " "
},
"typeSubType": {
"typeCode": "10",
"subTypeCode": "00"
},
"inputMessageAccountabilityData": {
"inputSource": "XYZ ABC ",
"inputSequenceNumber": "000001"
},
"amount": {
"amount": "000000100000"
},
"senderDepositoryInstitution": {
"senderABANumber": "091905114",
"senderShortName": "MIDWESTONE B&T"
},
"receiverDepositoryInstitution": {
"receiverABANumber": "091905664",
"receiverShortName": "PREMIER BANK"
},
"businessFunctionCode": {
"businessFunctionCode": "BTR",
"transactionTypeCode": " "
},
"senderReference": {
"senderReference": "Reference"
},
"localInstrument": {
"localInstrumentCode": "ANSI",
"proprietaryCode": "WJD786363"
},
"paymentNotification": {
"paymentNotificationIndicator": "1",
"contactNotificationElectronicAddress": "https://moov.io/",
"contactName": "Wade Arnold",
"contactPhoneNumber": "555-555-5555",
"contactMobileNumber": "555.555.555",
"faxNumber": "555.555.5555",
"endToEndIdentification": "WireTransfer 10001"
},
"charges": {
"chargeDetails": "B",
"sendersChargesOne": "USD1234,56",
"sendersChargesTwo": "USD1234,56",
"sendersChargesThree": "USD1234,56",
"sendersChargesFour": "USD1234,56"
},
"instructedAmount": {
"currencyCode": "USD"
},
"exchangeRate": {
"exchangeRate": "1.2345"
},
"beneficiaryIntermediaryFI": {
"identificationCode": "B"
},
"beneficiaryFI": {
"identificationCode": "B"
},
"beneficiary": {
"identificationCode": "B"
},
"beneficiaryReference": {
"beneficiaryReference": "Test Data"
},
"accountDebitedDrawdown": {
"identificationCode": "D"
},
"originator": {
"identificationCode": "B"
},
"originatorOptionF": {
"partyIdentifier": "/123456",
"name": "1/SMITH JOHN",
"lineOne": "2/123 MAIN STREET",
"lineTwo": "3/US/NEW YORK, NY 10000",
"lineThree": "7/111-22-3456"
},
"originatorFI": {
"identificationCode": "B"
},
"instructingFI": {
"identificationCode": "B"
},
"accountCreditedDrawdown": {
"drawdownCreditAccountNumber": "121042882"
},
"originatorToBeneficiary": {
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four"
},
"fiReceiverFI": {
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiDrawdownDebitAccountAdvice": {
"adviceCode": "HLD",
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiIntermediaryFI": {
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiIntermediaryFIAdvice": {
"adviceCode": "HLD",
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiBeneficiaryFI": {
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiBeneficiaryFIAdvice": {
"adviceCode": "HLD",
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiBeneficiary": {
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiBeneficiaryAdvice": {
"adviceCode": "HLD",
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"fiPaymentMethodToBeneficiary": {
"paymentMethod": "CHECK",
"AdditionalInformation": "For goods and services"
},
"fiAdditionalFIToFI": {
"lineOne": "Line One",
"lineTwo": "Line Two",
"lineThree": "Line Three",
"lineFour": "Line Four",
"lineFive": "Line Five",
"lineSix": "Line Six"
},
"currencyInstructedAmount": {
"swiftFieldTag": "SWIFT",
"amount": "1234,56"
},
"orderingCustomer": {
"swiftFieldTag": "SWIFT",
"swiftLineOne": "Swift Line One",
"swiftLineTwo": "Swift Line Two",
"swiftLineThree": "Swift Line Three",
"swiftLineFour": "Swift Line Four",
"swiftLineFive": "Swift Line Five",
"swiftLineSix": "Swift Line Six"
},
"orderingInstitution": {
"swiftFieldTag": "SWIFT",
"swiftLineOne": "Swift Line One",
"swiftLineTwo": "Swift Line Two",
"swiftLineThree": "Swift Line Three",
"swiftLineFour": "Swift Line Four",
"swiftLineFive": "Swift Line Five",
"swiftLineSix": "Swift Line Six"
},
"intermediaryInstitution": {
"swiftFieldTag": "SWIFT",
"swiftLineOne": "Swift Line One",
"swiftLineTwo": "Swift Line Two",
"swiftLineThree": "Swift Line Three",
"swiftLineFour": "Swift Line Four",
"swiftLineFive": "Swift Line Five",
"swiftLineSix": "Swift Line Six"
},
"institutionAccount": {
"swiftFieldTag": "SWIFT",
"swiftLineOne": "Swift Line One",
"swiftLineTwo": "Swift Line Two",
"swiftLineThree": "Swift Line Three",
"swiftLineFour": "Swift Line Four",
"swiftLineFive": "Swift Line Five",
"swiftLineSix": "Swift Line Six"
},
"beneficiaryCustomer": {
"swiftFieldTag": "SWIFT",
"swiftLineOne": "Swift Line One",
"swiftLineTwo": "Swift Line Two",
"swiftLineThree": "Swift Line Three",
"swiftLineFour": "Swift Line Four",
"swiftLineFive": "Swift Line Five",
"swiftLineSix": "Swift Line Six"
},
"remittance": {
"swiftFieldTag": "SWIFT",
"swiftLineOne": "Swift Line One",
"swiftLineTwo": "Swift Line Two",
"swiftLineThree": "Swift Line Three",
"swiftLineFour": "Swift Line Four",
"swiftLineFive": "Swift Line Five",
"swiftLineSix": "Swift Line Six"
},
"senderToReceiver": {
"swiftFieldTag": "SWIFT",
"swiftLineOne": "Swift Line One",
"swiftLineTwo": "Swift Line Two",
"swiftLineThree": "Swift Line Three",
"swiftLineFour": "Swift Line Four",
"swiftLineFive": "Swift Line Five",
"swiftLineSix": "Swift Line Six"
},
"unstructuredAddenda": {
"addendaLength": "0987",
"addenda": "Payment for goods"
},
"relatedRemittance": {
"remittanceIdentification": "Remittance Identification",
"remittanceLocationMethod": "EDIC",
"remittanceLocationElectronicAddress": "https://moov.io",
"remittanceData": {
"name": "Wade Arnold",
"addressType": "ADDR",
"department": "Buildings",
"subDepartment": "Service",
"streetName": "Street Way Boulevard",
"buildingNumber": "1A",
"postCode": "19465",
"townName": "Any Town",
"countrySubDivisionState": "PA",
"country": "US",
"addressLineOne": "AddressLineOne",
"addressLineTwo": "AddressLineTwo",
"addressLineThree": "AddressLineThree",
"addressLineFour": "AddressLineFour",
"addressLineFive": "AddressLineFive",
"addressLineSix": "AddressLineSix",
"addressLineSeven": "AddressLineSeven",
"countryOfResidence": "US"
}
},
"remittanceOriginator": {
"identificationType": "OI",
"identificationCode": "BANK",
"identificationNumber": "192827828",
"identificationNumberIssuer": "Identification Number Issuer",
"dateBirthPlace": "03062013 Chester",
"remittanceData": {
"name": "Wade Arnold",
"addressType": "ADDR",
"department": "Buildings",
"subDepartment": "Service",
"streetName": "Street Way Boulevard",
"buildingNumber": "1A",
"postCode": "19465",
"townName": "Any Town",
"countrySubDivisionState": "PA",
"country": "US",
"addressLineOne": "AddressLineOne",
"addressLineTwo": "AddressLineTwo",
"addressLineThree": "AddressLineThree",
"addressLineFour": "AddressLineFour",
"addressLineFive": "AddressLineFive",
"addressLineSix": "AddressLineSix",
"addressLineSeven": "AddressLineSeven",
"countryOfResidence": "US"
},
"countryOfResidence": "US",
"contactName": "Wade Arnold",
"contactPhoneNumber": "555.555.5555",
"contactMobileNumber": "555.555.5555",
"contactFaxNumber": "555.555.5555",
"contactElectronicAddress": "https://moov.io",
"contactOther": "Contact Other"
},
"remittanceBeneficiary": {
"identificationType": "OI",
"identificationCode": "BANK",
"identificationNumber": "192827828",
"identificationNumberIssuer": "Identification Number Issuer",
"dateBirthPlace": "03062013 Chester",
"remittanceData": {
"name": "Wade Arnold",
"addressType": "ADDR",
"department": "Buildings",
"subDepartment": "Service",
"streetName": "Street Way Boulevard",
"buildingNumber": "1A",
"postCode": "19465",
"townName": "Any Town",
"countrySubDivisionState": "PA",
"country": "US",
"addressLineOne": "AddressLineOne",
"addressLineTwo": "AddressLineTwo",
"addressLineThree": "AddressLineThree",
"addressLineFour": "AddressLineFour",
"addressLineFive": "AddressLineFive",
"addressLineSix": "AddressLineSix",
"addressLineSeven": "AddressLineSeven",
"countryOfResidence": "US"
}
},
"primaryRemittanceDocument": {
"documentTypeCode": "AROI",
"proprietaryDocumentTypeCode": "Proprietary Code",
"documentIdentificationNumber": "DOCUMENT 292828",
"issuer": "Remittance Issuer"
},
"actualAmountPaid": {
"currencyCode": "USD",
"amount": "1234.56789"
},
"grossAmountRemittanceDocument": {
"currencyCode": "USD",
"amount": "1234.56789"
},
"amountNegotiatedDiscount": {
"currencyCode": "USD",
"amount": "1234.56789"
},
"adjustment": {
"adjustmentReasonCode": "CM",
"creditDebitIndicator": "DBIT",
"currencyCode": "USD",
"amount": "1234.56789",
"additionalInfo": "Additional Info"
},
"dateRemittanceDocument": {
"dateRemittanceDocument": "20190401"
},
"secondaryRemittanceDocument": {
"documentTypeCode": "AROI",
"proprietaryDocumentTypeCode": "Proprietary",
"documentIdentificationNumber": "Document2",
"issuer": "Issuer"
},
"remittanceFreeText": {
"lineOne": "Line One Text",
"lineTwo": "Line Two Text",
"lineThree": "Line Three Text"
},
"serviceMessage": {
"lineOne": "Line One Text",
"lineTwo": "Line Two Text",
"lineThree": "Line Three Text",
"lineFour": "Line Four Text",
"lineFive": "Line Five Text",
"lineSix": "Line Six Text",
"lineSeven": "Line Seven Text",
"lineEight": "Line Eight Text",
"lineNine": "Line Nine Text",
"lineTen": "Line Ten Text",
"lineEleven": "Line Eleven Text",
"lineTwelve": "Line Twelve Text"
}
}Response
FEDWireMessage added to File