Wire Out File Layout
v2.1 - 11.2023
Purpose
Evolve sends a Wire Out file to the Customer for every originated wire transaction, detailing essential data. This file will be shared in the Platform’s preferred file format. The Customer is expected to update their subledger with this information and store each provided entry associated with a unique key.
This file is sent for each status update related to a wire origination transaction.
File Information
File Name
vAccount_Wire_Out_CompanyShortName_yyyyMMddHHmmss
- vAccount_Wire_Out is the File type and Version
- CompanyShortName is the short name assigned to the company by Evolve
- yyyyMMddHHmmss is the timestamp for when the file is sent
File Direction
This file is sent to the Platform from Evolve via sFTP.
Format Options
This file type is available in either CSV or JSON formats.
Delivery Details
Location
These files are delivered by default into a ‘Wire’ subfolder of the Platform’s primary folder on Evolve Bank & Trust’s sFTP server (sftp.getevolved.com). The Platform may choose a different subfolder if desired.
This folder is only created after the Wire Agreement has been signed.
Delivery Windows
The file is produced several times daily and will only include records that have not been send to the Platform in previous files.
Delivered daily (7 days a week) every hour from 5am - 6pm and at 10, 11pm Central Standard Time
AM CST | 5,6,7,8,9,10,11 |
---|---|
PM CST | 12,1,2,3,4,5,6,10,11 |
Each file delivery looks 5 days back. Each Saturday file delivery looks 30 days back.
Best Practice: When designing automated processes to pick up data received from Evolve, always check for new files as delivery window times may change or be added as needed.
File Size
Each file will contain no more than 2,000 records. If there are more than 2,000 records in a single delivery window, then multiple files will be provided.
Unique Key
Evolve requires that the data from this file be stored in association with a unique key to help identify errors or duplicate data in the event of a system issue.
Required Fields
IMAD + OMAD
Best Practice (add one or more of the following fields):
- amount
- status
File Options
JSON Sample Data
[
{
"account_actual":9876543210,
"account_virtual":"1200567890",
"customer_group":111,
"cif":"ZBB1234",
"account_actual_name":"PLATFORM CO",
"orig_name":"PATAGONIA",
"orig_address":"8550 WHITE FIR ST RENO, NV 89523<br />",
"benef_name":"3M",
"benef_address":"3M CENTER BUILDING 42-6E-37 ST PAUL MN 55144",
"wire_note":"REV YOUR PD REF",
"time_received":"2020-05-27T09:24:69",
"amount_text":"$19,445.00",
"amount":19445,
"imad":"20200527Z1A35X2B226799",
"omad":"20200527QYYCFGH2000568",
"in_out":"I",
"sequence":0,
"batch":0,
"status":"IN",
"wire_type":"S",
"wire_source":"FD",
"benef_bank":"EVOLVE",
"benef_bank_address":"",
"benef_reference":"",
"sender_reference":0,
"fi_to_fi":"",
"instructing_bank":"",
"orig_bank":"",
"orig_bank_address":"",
"orig_party":"",
"orig_optf_name":"",
"orig_optf_more":"",
"receiver_fi_info":"",
"previous_identifier":"",
"sending_aba":"867990054",
"sending_account":"9611111111224",
"jhtranid": ""
},
{
"account_actual":9876543210,
"account_virtual":"1200567923",
"customer_group":111,
"cif":"ZBB1234",
"account_actual_name":"PLATFORM CO",
"orig_name":"TESLA GIGAFACTORY 3",
"orig_address":"D203A, NO.168, TONGHUI ROAD, NANHUI NEW TOWN, PUDONG NEW AREA ZHENG JIA LU, FENGXIAN DISTRICT SHANGHAI",
"benef_name":"TESLA",
"benef_address":"4500 FREMONT BOULEVARD FREMONT CA 94538 US",
"wire_note":"1200567923",
"time_received":"2020-05-27T09:42:41",
"amount_text":"$22,000.00",
"amount":22000,
"imad":"20200528B4W8976G000567",
"omad":"20200528QYYCFGH2000468",
"in_out":"I",
"sequence":0,
"batch":0,
"status":"IN",
"wire_type":"S",
"wire_source":"FD",
"benef_bank":"EVOLVE",
"benef_bank_address":"",
"benef_reference":"",
"sender_reference":0,
"fi_to_fi":"/SFR1/",
"instructing_bank":"",
"orig_bank":"",
"orig_bank_address":"",
"orig_party":"",
"orig_optf_name":"",
"orig_optf_more":"",
"receiver_fi_info":"",
"previous_identifier":"",
"sending_aba":"670030707",
"sending_account":"9611111111224",
"jhtranid": ""
},
{
"account_actual":9876543210,
"account_virtual":"1200566088",
"customer_group":111,
"cif":"ZBB1234",
"account_actual_name":"PLATFORM CO",
"orig_name":"MICHAEL BOOTH",
"orig_address":"4343 1ST AVE APT 100 CHICAGO IL 60088 US",
"benef_name":"MICHAEL BOOTH",
"benef_address":"4343 1ST AVE APT 100 CHICAGO IL 60088 US",
"wire_note":"1200566088",
"time_received":"2020-05-28T01:58:54",
"amount_text":"$40,000.00",
"amount":40000,
"imad":"20200528T6GP443Y000998",
"omad":"20200528QYYCFGH2000569",
"in_out":"I",
"sequence":0,
"batch":0,
"status":"IN",
"wire_type":"S",
"wire_source":"FD",
"benef_bank":"EVOLVE",
"benef_bank_address":"",
"benef_reference":"OZZ1230012345",
"sender_reference":0,
"fi_to_fi":"",
"instructing_bank":"",
"orig_bank":"",
"orig_bank_address":"",
"orig_party":"",
"orig_optf_name":"",
"orig_optf_more":"",
"receiver_fi_info":"",
"previous_identifier":"",
"sending_aba":"670047804",
"sending_account":"9611111111224",
"jhtranid": ""
},
{
"account_actual":9876543210,
"account_virtual":"1200566099",
"customer_group":111,
"cif":"ZBB1234",
"account_actual_name":"PLATFORM CO",
"orig_name":"JAMES SCHWABB",
"orig_address":"7622 BENJAMIN ST NEW ORLEANS LA USA",
"benef_name":"EVOLVE BANK & TRUST HOME LOAN CENTER",
"benef_address":"175 NY-25E SETAUKET-EAST SETAUKET, NY 11733 ",
"wire_note":"1200566099",
"time_received":"2020-05-28T03:40:20",
"amount_text":"$6,000.00",
"amount":6000,
"imad":"20200528T5H9807H020798",
"omad":"20200528QYYCFGH2000570",
"in_out":"I",
"sequence":0,
"batch":0,
"status":"IN",
"wire_type":"S",
"wire_source":"FD",
"benef_bank":"EVOLVE",
"benef_bank_address":"",
"benef_reference":"",
"sender_reference":0,
"fi_to_fi":"",
"instructing_bank":"",
"orig_bank":"",
"orig_bank_address":"CITIBANK WASHINGTON 2000 L STREET 3RD FLOOR WASHINGTON DC 20036",
"orig_party":"",
"orig_optf_name":"",
"orig_optf_more":"",
"receiver_fi_info":"",
"previous_identifier":"",
"sending_aba":"450012772",
"sending_account":"9611111111224",
"jhtranid": ""
}
]
CSV Guidlines:
- Each record is located on a separate line, delimited by a line break (CRLF).
- The last record in the file may not have an ending line break.
- There will be a header line appearing as the first line of the file with the same format as normal record lines. This header will contain names corresponding to the fields in the file and will contain the same number of fields as the records in the rest of the file.
- Within the header and each record, there will be one or more fields, separated by commas. Each line should contain the same number of fields throughout the file. Spaces are considered part of a field and should not be ignored.
- The last field in the record will not be followed by a comma.
- Fields containing line breaks (CRLF), double quotes, and commas will be enclosed in double-quotes.
CSV Sample Data:
account_actual,account_virtual,customer_group,cif,account_actual_name,orig_name,orig_address,benef_name,benef_address,wire_note,time_received,amount_text,amount,imad,omad,in_out,sequence,batch,status,wire_type,wire_source,benef_bank,benef_bank_address,benef_reference,sender_reference,fi_to_fi,instructing_bank,orig_bank,orig_bank_address,orig_party,orig_optf_name,orig_optf_more,receiver_fi_info,previous_identifier,sending_aba,sending_account,jhtranid
9876543210,1200566088,111,"ZBB1234","PLATFORM CO","MICHAEL BOOTH","4343 1ST AVE APT 100 CHICAGO IL 60088 US","MICHAEL BOOTH","4343 1ST AVE APT 100 CHICAGO IL 60088 US","1200566088","2020-05-28T01:58:54","$40,000.00",40000,20200528T6GP443Y000998,20200528QYYCFGH2000569,I,0,0,IN,S,FD,"Evolve",,OZZ1230012345,0,,,,,,,,,,670047804,9611111111224,
Field Descriptions & Usage
These fields are described in terms of Wire Out transactions.
See our Wire In File Layout for alternative field descriptions for Wire In transactions.
Field | Type | Optional | Description |
---|---|---|---|
account_actual | Integer 10-16 digits | Settlement Account - Account number of the vAccount settlement account; account that is credited for the wire transfer | |
account_virtual | String 10-16 digits | Beneficiary Account – Account number that is credited for the wire transfer | |
customer_group | Integer 3 digits | Third Party Number – Evolve assigned integer used to group Platforms with their parent Third Party | |
cif | String | Customer ID - Evolve assigned ID used to identify the Platform or Third Party; CIF number tied to the Settlement Account | |
account_actual_name | String | Settlement Account Name – the name of the owner of the settlement account (e.g. Platform’s legal business name) | |
orig_name | String | Originator Name – name of the person or entity that originated the transaction | |
orig_address | String | Originator Address – address of the person or entity that originated the transaction | |
benef_name | String | Beneficiary Name – name of the person or entity receiving funds from the transaction | |
benef_address | String | Beneficiary Address – address of the person or entity receiving funds from the transaction; originator must provide the beneficiaries complete physical address | |
wire_note | String | Note – additional details appended to the transaction | |
time_received | Timestamp | Time Received – timestamp indicating when the beneficiary bank received the transaction (YYYY-MM-DDTHH:mm:ss) | |
amount_text | String | Amount Text – the transaction amount written with currency symbols and punctuation | |
amount | Decimal | Amount – the unsigned amount of the transaction; all funds are received in US Dollars | |
imad | String | Input Message Accountability Data (IMAD) - unique number given to each FedWire payment when using the Federal Reserve Bank Service. This unique number can be used to investigate and track wire transfers. | |
omad | String | Output Message Accountability Data (OMAD) - unique number given to each FedWire payment when using the Federal Reserve Bank Service. This unique number can be used to investigate and track wire transfers. | |
in_out | String | Transaction Direction – indicator that determines the direction of the transaction. Defined Values: • I – “Incoming transaction” or “Receiving transaction” • O – “Outgoing transaction” or “Sending transaction” | |
sequence | Integer 6 Digits | Sequence – – Evolve value assigned when wires are released; this value is used for retroactive review and provides additional detail to batch value; a value of “0” means the wire has not been sent yet | |
batch | Integer 3 Digits | Batch – Evolve value assigned when wires are released; this value is used for retroactive review; a value of “0” means the wire hasn’t been sent yet | |
status | String | Status – the status of the wire transaction being received. See the _Wire Out Status Codes _table below for more details. | |
wire_type | String | Type - value used to determine if the wire is Settled or Pending S – Settled R – Pending | |
wire_source | String | Source – value used to determine if the wire is Domestic or International Domestic – FD (Domestic Fedwire) International – ZN (Zions) or other correspondent bank code | |
benef_bank | String | Beneficiary Bank Name – name of the bank that received the transaction | |
benef_bank_address | String | yes | Beneficiary Bank Address – complete physical address of the bank that received the transaction |
benef_reference | String | yes | Beneficiary Reference – Reference value that provides additional detail or context to the beneficiary (eg. Invoice number) |
sender_reference | String | Originator Reference – Reference value that provides additional detail or context about the originator (eg. Bill number from accounts payable system) | |
fi_to_fi | String | yes | FI to FI (Financial Institution to Financial Institution) – notes passed between banks or financial institutions that provide additional details or context about the wire |
instructing_bank | String | yes | Instructing Bank - an instructing institution is a bank through which the wire transfer passes, between the sending bank and the originating bank |
orig_bank | String | yes | Originating Bank Name – name of the bank that originated the transaction |
orig_bank_address | String | Originating Bank Address – complete physical address of the bank that originated the transaction | |
orig_party | String | yes | Originating Party – identifier for the individual or business who originates the wire |
orig_optf_name | String | yes | Originating Party Name – name of the individual or business who originates the wire |
orig_optf_more | String | yes | Originating Party Details – additional details about the originating party, such as the address |
receiver_fi_info | String | yes | Receiver Financial Institution Information - additional information about the receiving financial institution |
previous_identifier | String | Previous Identifier - unique ID associated with previous transaction | |
sending_aba | String | Beneficiary Bank Routing Number – the ABA or routing number of the bank receiving domestic transactions; the SWIFT or BIC (Bank Identifier Code) of the bank receiving international transactions | |
sending_account | String | yes | This field only applies to incoming wires. See Wire In File Layout for more information. |
jhtranid | String | Transaction ID - a unique string of numbers and letters attached to a particular transaction assigned by the Core System |
Note: File produces an empty field to indicate a null response.
Wire Out Status Codes
These statuses are described in terms of Wire Out transactions.
See our Wire In File Layout for alternative statuses descriptions for Wire In transactions
Each status change of a wire is passed as a new entry. Specific statuses affect the Subledger balance.
Generally, the most often seen statuses for Wire Out are Auto Posted (AU), Initiated (IN), Manual Review (MR), and Processed (PR).
Final decision statuses are Auto Posted (AU), Processed (PR), Return Wire (RW), and Compliance Failure (CF). Clients should accept these statuses as the final decisioned state of the wire and operate their subledger based on these decisions. Please see the table below for additional instruction and details regarding status codes.
Status | Description | Update Ledger Balance |
---|---|---|
AU | Auto Posted – the transaction amount is below the auto post limits and auto posted to the account. | No, wait for success status like PR |
DR | Drawdown Request – A drawdown request is a request from another bank to send money to requesting bank in the requested amount. A drawdown request can be for both customer drawdowns and bank-to-bank drawdowns. | No, wait for drawdown to be acknowledged with HN status |
IN | Initiated - The wire has been initiated. Initiated outgoing wires will be sent to the Federal Reserve during the next communication window, at which time the status of the initiated wire is changed to PR. | No, wait for success status like PR |
IP | Internet Pending - The wire is an incomplete wire entered via eTeller Internet Banking and must either be completed via eTeller or by a bank employee. When a bank employee completes or modifies, the status will be changed to the appropriate status. | No |
ND | Next Day Wire - A wire created or initiated after the cutoff time that will not be sent until the next business day. | No, wait for success status like PR |
NR | Next Day Return Wire - A wire intended to be returned the following business day. | Yes, reverse previous ledger posting |
MR | Manual Review- Manual review comprises multiple auxiliary statuses, including OF and OP, that require manual intervention. | No, wait for success status like PR |
OF | OFAC Flagged Wire- A wire has been flagged for an OFAC review. Evolve must manually review and decision the wire before it can move into it's next status for further processing. | No |
OP | OFAC Pending Wire-A wire has been flagged for an OFAC review and is pending Evolve's manual review to decision the wire for further processing. | No |
PR | Processed - An outgoing wire that has been sent to the FedWire system. The presence of PR confirms the wire has been fully processed and posted. In an accepted wire scenario (has not been returned with RW), clients should accept the PR status as the final decisioned state of the wire. Subsequent statuses serve as processing detail. | Yes |
RJ | Rejected Wire - The FedWire system cannot process an outgoing wire. A message appears indicating the problem and the wire is placed in RJ status. A bank employee will contact the sending partner to correct the error and reinitiate the wire. The wire is then sent with a new IMAD. Applies to value and non-value messages. When a wire is rejected, the posting on the Evolve bank account remains in place with the expectation that the error will be corrected and the wire will be sent before cut-off time. | If the error is corrected and the wire is sent, no. If the error is not corrected, reverse the previous posting. |
RL | Late Return - An outgoing wire that has been created from an incoming wire that is being returned because it was received after the cut-off time. | Yes, reverse previous ledger posting |
RT | Incoming Return Wire - A previous day's incoming wire that is being returned. | Yes |
RW | Return Wire - An outgoing wire serving as the return, created from the incoming wire. Clients should accept the RW status as the final decisioned state of the wire. Subsequent status, such as PR, serve as processing detail and confirmation of the wire being processed. Note: The outgoing RW record will share the same IMAD as the incoming wire record. However, once processed (PR) the outgoing wire will receive a new IMAD. | End User should not receive credit for the incoming wire |
CF | Compliance Failure - A wire that has failed compliance due to a regulatory issue. | No |
Updated about 2 months ago