Wire In File Layout
v2.1 - 11.2023
Purpose
When a wire transaction is received, Evolve will notify the Third Party or Platform with this file. This file will be shared in the Platform’s preferred file format. The Platform is expected to use this data to update their subledger and store each provided entry associated with a unique key. This file delivers essential data regarding each wire transaction Evolve receives for the Third Party, Platform, or End User.
This file will be sent for every status update regarding a wire in transaction.
File Information
File Name
vAccount_Wire_In_CompanyShortName_yyyyMMddHHmmss
- vAccount_Wire_In 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). However, the Platform may choose a different subfolder if desired.
Delivery Windows
When the file is produced, entries only include records that have not been sent to the Platform in previous files. This file type is provided several times a day and contains wire data for previously received wire transactions.
Delivered daily (7 days a week) every hour from 5 am to 6 pm and at 10, 11 pm Central Time
| AM | 5,6,7,8,9,10,11 |
|---|---|
| NOON | 12 |
| PM | 1,2,3,4,5,6,10,11 |
Best Practice: When designing automated processes to pick up data received from Evolve, always look for new files. Delivery window times are subject to change or to be added as needed.
File Size
This 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. This key will help the Platform 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":"",
"jhtranid": "JWSZFAHMJO"
},
{
"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":"",
"jhtranid": "JWSZFAHMJO"
},
{
"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":"",
"jhtranid": "JWSZFAHMJO"
},
{
"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":"",
"jhtranid": "JWSZFAHMJO"
}
]
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,,JWSZFAHMJO
Field Descriptions & Usage
These fields are described in terms of Wire In Transactions.
See our Wire Out File Layout for alternative field descriptions for Wire Out 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 | vAccount – virtual account number issued to the End User; If no vAccount number is present, the settlement account number will populate this field. | |
| 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 | Sequence – value assigned when wires are released; this value is used for retroactive review and provides additional detail to batch value | |
| batch | Integer | Batch – value assigned when wires are released; this value is used for retroactive review. | |
| status | String | Status – the status of the wire transaction being received. See the _Wire In 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 | Originating Bank Routing Number – the sending bank’s ABA or routing number when receiving domestic transactions; SWIFT or BIC (Bank Identifier Code) when receiving international transactions | |
| sending_account | String | yes | Originating Account – account number to be debited for the transaction |
| jhtranid | String | Transaction ID - a unique string of numbers and letters attached to a particular transaction assigned by the Core System |
Wire In Status Codes:
These statuses are described in terms of Wire In transactions.
See our Wire Out File Layout for alternative statuses descriptions for Wire Out transactions.
Generally, the most often seen statuses for Wire In are Auto Posted (AU), Initiated (IN), Manual Review (MR), and Processed (PR).
Final decision statuses are Auto Posted (AU), Processed (PR), 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.
For drawdowns, this must be explicitly agreed to in the Wire Agreement. Additionally, drawdowns only pertain to Core level accounts and not vAccounts.
| 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 |
| HN | Honored Drawdown – A drawdown request has been honored and the outgoing drawdown response wire has been created with the appropriate information pre-filled from the original request. No further responses are allowed to the original request. This status indicates that an outgoing wire was created to satisfy the drawdown request. | Yes |
| IN | Initiated - The wire has been initiated. | No, wait for success status like PR |
| 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 |
| 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 |
| RC | Return Credit- An incoming wire where the credit is returned prior to posting. | No |
| RF | Refused Drawdown - When a drawdown request is refused, a refusal message is created and sent to the requesting bank via the FedWire system. The status of the original drawdown request is changed to RF. | No |
| RT | Incoming Return Wire - An outgoing wire that is being returned to Evolve. | Yes |
| RW | Return Wire - An incoming wire that may require a return. RW wires should not be ledgered and must await a decision. There are two outcomes of an RW wire: 1. The status moves from RW>PR: incoming credits were returned to the sender. All RWs that are returned will have a corresponding wire with RW status in the Wire Out File. 2. The status moves from RW>IN>PR: incoming credits were received and are to be posted to the receiving end user. Note: When an incoming wire is flagged for return, an outgoing wire is created with a status of RW. Once processed (PR), the outgoing wire will be assigned its own unique IMAD, independent from the IMAD associated with the incoming wire. For example, an incoming wire has an IMAD of 20200101A1B1111C000011, the outgoing wire RW will correspond with the same IMAD. However, once the status changes from RW>PR in the Wire Out file, it will be assigned it's own unique IMAD, 20200101B1C2222D000022. | No, wait for success status like PR |
| PR | Processed - An incoming wire that has been received from the FedWire system and has been fully processed. The presence of PR confirms the wire has been 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. In a return scenario (RW), the PR confirms that the return wire has been fully processed. | Yes |
| CF | Compliance Failure - A wire that has failed compliance due to a regulatory issue. There will be a corresponding return wire with the original IMAD. | No |
Updated about 2 months ago
What’s Next