message-structure.md

July 7, 2021 · View on GitHub

Mandatory tags

Name
SenderSupplied
TypeSubType
InputMessageAccountabilityData
Amount
SenderDepositoryInstitution
ReceiverDepositoryInstitution
BusinessFunctionCode

SenderSupplied

NameTypeDescriptionNotes
FormatVersionstringFormatVersion 30
UserRequestCorrelationstringUserRequestCorrelation
TestProductionCodestringTestProductionCode
  • T - Test
  • P - Production
  • MessageDuplicationCodestringMessageDuplicationCode
  • - Original Message
  • R - Retrieval of an original message
  • P - Resend
  • TypeSubType

    NameTypeDescriptionNotes
    TypeCodestringTypeCode:
  • 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.
  • SubTypeCodestringSubTypeCode:
  • 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 (IMAD)

    NameTypeDescriptionNotes
    InputCycleDatestringInputCycleDate CCYYMMDD
    InputSourcestringInputSource
    InputSequenceNumberstringInputSequenceNumber

    Amount

    NameTypeDescriptionNotes
    AmountstringAmount 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

    SenderDepositoryInstitution

    NameTypeDescriptionNotes
    SenderABANumberstringSenderABANumber
    SenderShortNamestringSenderShortName

    ReceiverDepositoryInstitution

    NameTypeDescriptionNotes
    ReceiverABANumberstringReceiverABANumber
    ReceiverShortNamestringReceiverShortName

    BusinessFunctionCode

    NameTypeDescriptionNotes
    BusinessFunctionCodestringBusinessFunctionCode
  • 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
  • TransactionTypeCodestringTransactionTypeCode If {3600} is CTR, an optional Transaction Type Code element is permitted; however, the Transaction Type Code 'COV' is not permitted.[optional]

    Other Transfer Information

    SenderReference

    NameTypeDescriptionNotes
    SenderReferencestringSenderReference[optional]

    LocalInstrument

    NameTypeDescriptionNotes
    LocalInstrumentCodestringLocalInstrument
  • 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
  • [optional]
    ProprietaryCodestringProprietaryCode[optional]

    PaymentNotification

    NameTypeDescriptionNotes
    PaymentNotificationIndicatorstringPaymentNotificationIndicator
  • 0 - 6 - Reserved for market practice conventions.
  • 7 - 9 - Reserved for bilateral agreements between Fedwire senders and receivers.
  • [optional]
    ContactNotificationElectronicAddressstringContactNotificationElectronicAddress[optional]
    ContactNamestringContactName[optional]
    ContactPhoneNumberstringContactPhoneNumber[optional]
    ContactMobileNumberstringContactMobileNumber[optional]
    FaxNumberstringFaxNumber[optional]
    EndToEndIdentificationstringEndToEndIdentification[optional]

    Charges

    NameTypeDescriptionNotes
    ChargeDetailsstringChargeDetails
  • B - Beneficiary
  • S - Shared
  • [optional]
    SendersChargesOnestringSendersChargesOne 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.[optional]
    SendersChargesTwostringSendersChargesTwo 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.[optional]
    SendersChargesThreestringSendersChargesThree 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.[optional]
    SendersChargesFourstringSendersChargesFour 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.[optional]

    InstructedAmount

    NameTypeDescriptionNotes
    CurrencyCodestringCurrencyCode[optional]
    AmountstringAmount 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[optional]

    ExchangeRate

    NameTypeDescriptionNotes
    ExchangeRatestringExchangeRate 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).[optional]

    Beneficiary Information

    IntermediaryFI

    NameTypeDescriptionNotes
    IdentificationCodestringIdentificationCode:
  • 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
  • IdentifierstringIdentifier
    NamestringName
    AddressAddress

    BeneficiaryFI

    NameTypeDescriptionNotes
    IdentificationCodestringIdentificationCode:
  • 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
  • IdentifierstringIdentifier
    NamestringName
    AddressAddress

    Beneficiary

    NameTypeDescriptionNotes
    IdentificationCodestringIdentificationCode:
  • 1 - Passport Number
  • 2 - Tax Identification Number
  • 3 - Driver’s License Number
  • 4 - Alien Registration Number
  • 5 - Corporate Identification
  • 9 - Other Identification
  • IdentifierstringIdentifier
    NamestringName
    AddressAddress

    BeneficiaryReference

    NameTypeDescriptionNotes
    BeneficiaryReferencestringBeneficiaryReference[optional]

    AccountDebitedDrawdown

    NameTypeDescriptionNotes
    IdentificationCodestringIdentification Code
  • D - Debit
  • IdentifierstringIdentifier
    NamestringName
    AddressAddress[optional]

    Originator Information

    Originator

    NameTypeDescriptionNotes
    IdentificationCodestringIdentificationCode:
  • 1 - Passport Number
  • 2 - Tax Identification Number
  • 3 - Driver’s License Number
  • 4 - Alien Registration Number
  • 5 - Corporate Identification
  • 9 - Other Identification
  • IdentifierstringIdentifier
    NamestringName
    AddressAddress

    OriginatorOptionF

    NameTypeDescriptionNotes
    PartyIdentifierstringPartyIdentifier 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[optional]
    NamestringName Format: Must begin with Line Code 1 followed by a slash and at least one valid non-space character: e.g., 1/SMITH JOHN.[optional]
    LineOnestringLineOne 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[optional]
    LineTwostringLineTwo 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[optional]
    LineThreestringLineThree 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[optional]

    OriginatorFI

    NameTypeDescriptionNotes
    IdentificationCodestringIdentificationCode:
  • 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
  • IdentifierstringIdentifier
    NamestringName
    AddressAddress

    InstructingFI

    NameTypeDescriptionNotes
    IdentificationCodestringIdentificationCode:
  • 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
  • IdentifierstringIdentifier
    NamestringName
    AddressAddress

    AccountCreditedDrawdown

    NameTypeDescriptionNotes
    DrawdownCreditAccountNumberstringDrawdownCreditAccountNumber 9 character ABA[optional]

    OriginatorToBeneficiary

    NameTypeDescriptionNotes
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]

    Financial Institution to Financial Institution Information

    ReceiverFI

    NameTypeDescriptionNotes
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    DrawdownDebitAccountAdvice

    NameTypeDescriptionNotes
    NameTypeDescriptionNotes
    ---------------------------------------------------
    AdviceCodestringAdviceCode
  • HLD - Hold
  • LTR - Letter
  • PHN - Phone
  • TLX - Telex
  • WRE - Wire
  • [optional]
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    IntermediaryFI

    NameTypeDescriptionNotes
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    IntermediaryFIAdvice

    NameTypeDescriptionNotes
    AdviceCodestringAdviceCode
  • HLD - Hold
  • LTR - Letter
  • PHN - Phone
  • TLX - Telex
  • WRE - Wire
  • [optional]
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    BeneficiaryFI

    NameTypeDescriptionNotes
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    BeneficiaryFIAdvice

    NameTypeDescriptionNotes
    AdviceCodestringAdviceCode
  • HLD - Hold
  • LTR - Letter
  • PHN - Phone
  • TLX - Telex
  • WRE - Wire
  • [optional]
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    Beneficiary

    NameTypeDescriptionNotes
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    Beneficiary Advice

    NameTypeDescriptionNotes
    AdviceCodestringAdviceCode
  • HLD - Hold
  • LTR - Letter
  • PHN - Phone
  • TLX - Telex
  • WRE - Wire
  • [optional]
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    PaymentMethodToBeneficiary

    NameTypeDescriptionNotes
    PaymentMethodstringPaymentMethod[optional]
    Additionalstring[optional]

    AdditionalFiToFi

    NameTypeDescriptionNotes
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]
    LineFourstringLineFour[optional]
    LineFivestringLineFive[optional]
    LineSixstringLineSix[optional]

    Cover Payment Information

    CurrencyInstructedAmount

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    AmountstringAmount[optional]

    OrderingCustomer

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    SwiftLineOnestringSwiftLineOne[optional]
    SwiftLineTwostringSwiftLineTwo[optional]
    SwiftLineThreestringSwiftLineThree[optional]
    SwiftLineFourstringSwiftLineFour[optional]
    SwiftLineFivestringSwiftLineFive[optional]

    OrderingInstitution

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    SwiftLineOnestringSwiftLineOne[optional]
    SwiftLineTwostringSwiftLineTwo[optional]
    SwiftLineThreestringSwiftLineThree[optional]
    SwiftLineFourstringSwiftLineFour[optional]
    SwiftLineFivestringSwiftLineFive[optional]

    IntermediaryInstitution

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    SwiftLineOnestringSwiftLineOne[optional]
    SwiftLineTwostringSwiftLineTwo[optional]
    SwiftLineThreestringSwiftLineThree[optional]
    SwiftLineFourstringSwiftLineFour[optional]
    SwiftLineFivestringSwiftLineFive[optional]

    InstitutionAccount

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    SwiftLineOnestringSwiftLineOne[optional]
    SwiftLineTwostringSwiftLineTwo[optional]
    SwiftLineThreestringSwiftLineThree[optional]
    SwiftLineFourstringSwiftLineFour[optional]
    SwiftLineFivestringSwiftLineFive[optional]

    BeneficiaryCustomer

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    SwiftLineOnestringSwiftLineOne[optional]
    SwiftLineTwostringSwiftLineTwo[optional]
    SwiftLineThreestringSwiftLineThree[optional]
    SwiftLineFourstringSwiftLineFour[optional]
    SwiftLineFivestringSwiftLineFive[optional]

    Remittance

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    SwiftLineOnestringSwiftLineOne[optional]
    SwiftLineTwostringSwiftLineTwo[optional]
    SwiftLineThreestringSwiftLineThree[optional]
    SwiftLineFourstringSwiftLineFour[optional]

    Sender to Receiver

    NameTypeDescriptionNotes
    SwiftFieldTagstringSwiftFieldTag[optional]
    SwiftLineOnestringSwiftLineOne[optional]
    SwiftLineTwostringSwiftLineTwo[optional]
    SwiftLineThreestringSwiftLineThree[optional]
    SwiftLineFourstringSwiftLineFour[optional]
    SwiftLineFivestringSwiftLineFive[optional]
    SwiftLineSixstringSwiftLineSix[optional]

    Unstructured Addenda

    NameTypeDescriptionNotes
    AddendaLengthstringAddendaLength 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).[optional]
    AddendastringAddenda[optional]

    RelatedRemittance

    NameTypeDescriptionNotes
    RemittanceIdentificationstringRemittanceIdentification[optional]
    RemittanceLocationMethodstringRemittanceLocationMethod
  • EDIC - Electronic Data Interchange
  • EMAL - Email
  • FAXI - Fax
  • POST - Postal services
  • SMS - Short Message Service (text)
  • URI - Uniform Resource Identifier
  • [optional]
    RemittanceLocationElectronicAddressstringRemittanceLocationElectronicAddress (E-mail or URL address)[optional]
    RemittanceDataRemittanceData[optional]

    Structured Remittance Information

    RemittanceOriginator

    NameTypeDescriptionNotes
    IdentificationTypestringIdentificationType
  • OI - Organization ID
  • PI - Private ID
  • [optional]
    IdentificationCodestringIdentificationCode 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
  • [optional]
    IdentificationNumberstringIdentificationNumber[optional]
    IdentificationNumberIssuerstringIdentificationNumberIssuer[optional]
    DateBirthPlacestringDateBirthPlace[optional]
    RemittanceDataRemittanceData[optional]
    CountryOfResidencestringCountryOfResidence[optional]
    ContactNamestringContactName[optional]
    ContactPhoneNumberstringContactPhoneNumber[optional]
    ContactMobileNumberstringContactMobileNumber[optional]
    ContactFaxNumberstringContactFaxNumber[optional]
    ContactElectronicAddressstringContactElectronicAddress ( i.e., E-mail or URL address)[optional]
    ContactOtherstringContactOther[optional]

    RemittanceBeneficiary

    NameTypeDescriptionNotes
    IdentificationTypestringIdentificationType
  • OI - Organization ID
  • PI - Private ID
  • [optional]
    IdentificationCodestringIdentificationCode 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
  • [optional]
    IdentificationNumberstringIdentificationNumber[optional]
    IdentificationNumberIssuerstringIdentificationNumberIssuer[optional]
    DateBirthPlacestringDateBirthPlace[optional]
    RemittanceDataRemittanceData[optional]

    PrimaryRemittanceDocument

    NameTypeDescriptionNotes
    DocumentTypeCodestringDocumentTypeCode
  • 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
  • [optional]
    ProprietaryDocumentTypeCodestringProprietaryDocumentTypeCode[optional]
    DocumentIdentificationNumberstringDocumentIdentificationNumber[optional]
    IssuerstringIssuer[optional]

    ActualAmountPaid

    NameTypeDescriptionNotes
    CurrencyCodestringCurrencyCode[optional]
    AmountstringAmount 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).[optional]

    GrossAmountOfRemittanceDocument

    NameTypeDescriptionNotes
    CurrencyCodestringCurrencyCode[optional]
    AmountstringAmount 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).[optional]

    AmountNegotiatedDiscount

    NameTypeDescriptionNotes
    CurrencyCodestringCurrencyCode[optional]
    AmountstringAmount 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).[optional]

    Adjustment

    NameTypeDescriptionNotes
    AdjustmentReasonCodestringAdjustment
  • 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
  • [optional]
    CreditDebitIndicatorstringCreditDebitIndicator
  • CRDT - Credit
  • DBIT - Debit
  • [optional]
    CurrencyCodestringCurrencyCode[optional]
    AmountstringAmount 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).[optional]
    AdditionalInfostringAdditionalInfo[optional]

    DateRemittanceDocument

    NameTypeDescriptionNotes
    DateRemittanceDocumentstringDateRemittanceDocument CCYYMMDD[optional]

    SecondaryRemittanceDocument

    NameTypeDescriptionNotes
    DocumentTypeCodestringSecondaryRemittanceDocument
  • 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
  • [optional]
    ProprietaryDocumentTypeCodestringproprietaryDocumentTypeCode[optional]
    DocumentIdentificationNumberstringdocumentIdentificationNumber[optional]
    IssuerstringIssuer[optional]

    RemittanceFreeText

    NameTypeDescriptionNotes
    LineOnestringLineOne[optional]
    LineTwostringLineTwo[optional]
    LineThreestringLineThree[optional]

    Information Appended by the FEDWire Funds Service

    MessageDisposition

    NameTypeDescriptionNotes
    FormatVersionstringFormatVersion 30[optional]
    TestProductionCodestringTestProductionCode
  • T - Test
  • P - Production
  • [optional]
    MessageDuplicationCodestringMessageDuplicationCode
  • - Original Message
  • R - Retrieval of an original message
  • P - Resend
  • [optional]
    MessageStatusIndicatorstringMessage Status Indicator 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)
  • [optional]

    ReceiptTimeStamp

    NameTypeDescriptionNotes
    ReceiptDateDateDate[optional]
    ReceiptTimeTimeTime[optional]
    ReceiptApplicationIdentificationstringApplicationIdentification[optional]

    OutputMessageAccountabilityData

    NameTypeDescriptionNotes
    OutputCycleDatestringOutputCycleDate (CCYYMMDD)[optional]
    OutputDestinationIDstringOutputDestinationID[optional]
    OutputSequenceNumberstringoutputSequenceNumber[optional]
    OutputDateDateDate[optional]
    OutputTimeTimeTime[optional]
    OutputFRBApplicationIdentificationstringOutputFRBApplicationIdentification[optional]

    ErrorWire

    NameTypeDescriptionNotes
    ErrorCategorystring
  • E - Data Error
  • F - Insufficient Balance
  • H - Accountability Error
  • I - In Process or Intercepted
  • W - Cutoff Hour Error
  • X - Duplicate IMAD
  • [optional]
    ErrorCodestringErrorCode[optional]
    ErrorDescriptionstringErrorDescription[optional]