Wire Search

openapi: 3.0.1 info: title: Wire Search description: '' version: '1.0' x-jh: publishing: type: Integration stage: prod isPublic: true group: Origin-Wires name: Jack Henry Wires paths: /v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductCode}/wires/transactions-search: post: tags: - Wire Search summary: API to search for existing wire transactions parameters: - name: offset in: query description: The service offset provided by the API provider schema: type: string description: The service offset provided by the API provider example: '11' - name: count in: query description: The service offset provided by the API provider schema: type: string example: '10' - name: Content-Type in: header description: 'Content Type. Example: application/json' required: true schema: type: string default: application/json - name: X-Request-Id in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-Id in: header description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) allowEmptyValue: true schema: type: string - name: X-AuditUserId in: header description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information. allowEmptyValue: true schema: type: string - name: X-AuditDeviceId in: header description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id. allowEmptyValue: true schema: type: string - name: X-BusinessCorrelationId in: header description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. allowEmptyValue: true schema: type: string - name: X-WorkflowCorrelationId in: header description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. allowEmptyValue: true schema: type: string - name: Authorization in: header description: >- JWT Token. Represents Callers Authentication Token in the form of a JWT generated by a OAuth 2.0 Identity Provider and conforms to the OpenID Connect specification. See [Security section] for other details. <br>Example `Authorization: jwt:<GeneratedOidcJwt>` <br>Example `Authorization: saml:<Generatedsaml>` required: true schema: type: string default: Authorization - name: X-AuthenticationUserCredential in: header description: >- Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). Example: AuthenticationUserCredential: jwt:<GeneratedOidcJwt>, AuthenticationUserCredential: saml:<Generatedsaml> allowEmptyValue: true schema: type: string - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as Authorization jwt unless the message is sent on-behalf-of this consumer product. Example: AuthenticationProductCredential: jwt:<GeneratedOidcJwt> required: true schema: type: string - name: X-FaultOverrideList in: header description: >- A comma separated list with error codes that are to be considered to be overridden. schema: type: string - name: InstitutionId in: path description: >- The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: >- The Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: ProductCode in: path description: The code as related to a product. required: true schema: type: string default: CSS requestBody: description: Request model content: application/json: schema: type: object properties: accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 statuses: type: array items: type: object properties: processStep: type: string nullable: true state: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false description: An array of statuses related to a wire nullable: true createStartDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' createEndDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name sourceTypes: type: array items: enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FileImport - FinancialInstitutionClerk type: string example: FileImport description: An array of source types nullable: true transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true wireId: type: string description: The identifier given to a specific wire transaction nullable: true example: d6e9628a-7d71-4dcc-bed6-2983624fa670 lowAmount: type: number description: >- A generic amount for the lowest amount for a wire for the search criteria format: double nullable: true example: '15000.00' highAmount: type: number description: >- A generic amount for the highest amount for a wire for the search criteria format: double nullable: true example: '1000000.00' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan institutionId: type: string description: >- The routing id of either the sending financial institution or the receiving financial institution nullable: true example: '011104351' institutionName: type: string description: >- The name of any of the following institutions in a wire record - beneficiary, originator, intermediary, instruction, receiver nullable: true example: Acme Bank id: type: string description: >- An identifier for either the wire identification number or the customer id nullable: true example: C03982983 branchCode: type: string description: >- The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: >- An open enum representing the code assigned to a product in the core nullable: true returnType: type: string description: Identifies the ReturnType nullable: true enum: - 'True' - 'False' remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'True' - 'False' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' sorting: type: array items: required: - columnName type: object properties: columnName: minLength: 1 type: string isAscending: type: boolean sortOrder: maximum: 2147483647 minimum: 1 type: integer format: int32 additionalProperties: false nullable: true additionalProperties: false description: Search Wire Model text/json: schema: type: object properties: accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 statuses: type: array items: type: object properties: processStep: type: string nullable: true state: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false description: An array of statuses related to a wire nullable: true createStartDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' createEndDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name sourceTypes: type: array items: enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FileImport - FinancialInstitutionClerk type: string example: FileImport description: An array of source types nullable: true transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true wireId: type: string description: The identifier given to a specific wire transaction nullable: true example: d6e9628a-7d71-4dcc-bed6-2983624fa670 lowAmount: type: number description: >- A generic amount for the lowest amount for a wire for the search criteria format: double nullable: true example: '15000.00' highAmount: type: number description: >- A generic amount for the highest amount for a wire for the search criteria format: double nullable: true example: '1000000.00' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan institutionId: type: string description: >- The routing id of either the sending financial institution or the receiving financial institution nullable: true example: '011104351' institutionName: type: string description: >- The name of any of the following institutions in a wire record - beneficiary, originator, intermediary, instruction, receiver nullable: true example: Acme Bank id: type: string description: >- An identifier for either the wire identification number or the customer id nullable: true example: C03982983 branchCode: type: string description: >- The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: >- An open enum representing the code assigned to a product in the core nullable: true returnType: type: string description: Identifies the ReturnType nullable: true enum: - 'True' - 'False' remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'True' - 'False' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' sorting: type: array items: required: - columnName type: object properties: columnName: minLength: 1 type: string isAscending: type: boolean sortOrder: maximum: 2147483647 minimum: 1 type: integer format: int32 additionalProperties: false nullable: true additionalProperties: false description: Search Wire Model application/*+json: schema: type: object properties: accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 statuses: type: array items: type: object properties: processStep: type: string nullable: true state: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false description: An array of statuses related to a wire nullable: true createStartDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' createEndDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name sourceTypes: type: array items: enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FileImport - FinancialInstitutionClerk type: string example: FileImport description: An array of source types nullable: true transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true wireId: type: string description: The identifier given to a specific wire transaction nullable: true example: d6e9628a-7d71-4dcc-bed6-2983624fa670 lowAmount: type: number description: >- A generic amount for the lowest amount for a wire for the search criteria format: double nullable: true example: '15000.00' highAmount: type: number description: >- A generic amount for the highest amount for a wire for the search criteria format: double nullable: true example: '1000000.00' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan institutionId: type: string description: >- The routing id of either the sending financial institution or the receiving financial institution nullable: true example: '011104351' institutionName: type: string description: >- The name of any of the following institutions in a wire record - beneficiary, originator, intermediary, instruction, receiver nullable: true example: Acme Bank id: type: string description: >- An identifier for either the wire identification number or the customer id nullable: true example: C03982983 branchCode: type: string description: >- The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: >- An open enum representing the code assigned to a product in the core nullable: true returnType: type: string description: Identifies the ReturnType nullable: true enum: - 'True' - 'False' remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'True' - 'False' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' sorting: type: array items: required: - columnName type: object properties: columnName: minLength: 1 type: string isAscending: type: boolean sortOrder: maximum: 2147483647 minimum: 1 type: integer format: int32 additionalProperties: false nullable: true additionalProperties: false description: Search Wire Model responses: '200': description: Success headers: X-Request-Id: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-Id: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) allowEmptyValue: true schema: type: string format: uuid example: 283a8c83-625c-43bb-8e5e-ec17e8f3adcc X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. allowEmptyValue: true schema: type: string format: uuid example: d42dae3a-f0f8-467f-a385-7a53c3ee0bd3 X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. allowEmptyValue: true schema: type: string format: uuid example: 2554a29c-802d-42a2-ac82-d6bbe1608ab1 content: text/plain: schema: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: >- The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false wires: type: array items: type: object properties: wireId: type: string description: The identifier given to a specific wire transaction format: uuid example: d6e9628a-7d71-4dcc-bed6-2983624fa670 transactionDescription: type: string description: >- A human readable description for a specific wire transaction nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 status: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeApprovalUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeIPAddress: type: string description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true statusId: type: string format: uuid nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false createDate: type: string description: >- The Greenwich Mean time/date the wire was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2021-01-30T08:30:00Z' amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount sourceType: type: string description: >- Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: >- ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: >- ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true returnType: type: string description: The return type of specific wire if/when applicable nullable: true remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: >- The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' thirdPartyStatus: enum: - Held - Pending - Approved type: string nullable: true description: >- The third party status of a wire that is under third party control. This describes the state of a wire in the approval process in a third-party system that originated the wire example: Held effectiveDate: type: string description: The date a wire was sent to the Federal Reserve format: date-time nullable: true sendDate: type: string description: The date the wire was initiated format: date-time nullable: true additionalProperties: false description: Search Wire Response Model description: an array of summarized wires details nullable: true paging: type: object properties: nextOffset: type: integer description: >- The next 'page' number to specify in your next search to get the next results after these. format: int32 example: '2' results: type: integer description: The number of results returned in this result set. format: int32 example: '20' total: type: integer description: The total number of items found in the search results. format: int64 example: '173' additionalProperties: false description: Wire Search Response application/json: schema: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: >- The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false wires: type: array items: type: object properties: wireId: type: string description: The identifier given to a specific wire transaction format: uuid example: d6e9628a-7d71-4dcc-bed6-2983624fa670 transactionDescription: type: string description: >- A human readable description for a specific wire transaction nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 status: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeApprovalUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeIPAddress: type: string description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true statusId: type: string format: uuid nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false createDate: type: string description: >- The Greenwich Mean time/date the wire was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2021-01-30T08:30:00Z' amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount sourceType: type: string description: >- Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: >- ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: >- ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true returnType: type: string description: The return type of specific wire if/when applicable nullable: true remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: >- The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' thirdPartyStatus: enum: - Held - Pending - Approved type: string nullable: true description: >- The third party status of a wire that is under third party control. This describes the state of a wire in the approval process in a third-party system that originated the wire example: Held effectiveDate: type: string description: The date a wire was sent to the Federal Reserve format: date-time nullable: true sendDate: type: string description: The date the wire was initiated format: date-time nullable: true additionalProperties: false description: Search Wire Response Model description: an array of summarized wires details nullable: true paging: type: object properties: nextOffset: type: integer description: >- The next 'page' number to specify in your next search to get the next results after these. format: int32 example: '2' results: type: integer description: The number of results returned in this result set. format: int32 example: '20' total: type: integer description: The total number of items found in the search results. format: int64 example: '173' additionalProperties: false description: Wire Search Response text/json: schema: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: >- The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false wires: type: array items: type: object properties: wireId: type: string description: The identifier given to a specific wire transaction format: uuid example: d6e9628a-7d71-4dcc-bed6-2983624fa670 transactionDescription: type: string description: >- A human readable description for a specific wire transaction nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 status: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeApprovalUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeIPAddress: type: string description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true statusId: type: string format: uuid nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false createDate: type: string description: >- The Greenwich Mean time/date the wire was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2021-01-30T08:30:00Z' amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount sourceType: type: string description: >- Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: >- ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: >- ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true returnType: type: string description: The return type of specific wire if/when applicable nullable: true remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: >- The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' thirdPartyStatus: enum: - Held - Pending - Approved type: string nullable: true description: >- The third party status of a wire that is under third party control. This describes the state of a wire in the approval process in a third-party system that originated the wire example: Held effectiveDate: type: string description: The date a wire was sent to the Federal Reserve format: date-time nullable: true sendDate: type: string description: The date the wire was initiated format: date-time nullable: true additionalProperties: false description: Search Wire Response Model description: an array of summarized wires details nullable: true paging: type: object properties: nextOffset: type: integer description: >- The next 'page' number to specify in your next search to get the next results after these. format: int32 example: '2' results: type: integer description: The number of results returned in this result set. format: int32 example: '20' total: type: integer description: The total number of items found in the search results. format: int64 example: '173' additionalProperties: false description: Wire Search Response '400': description: Bad Request headers: X-Request-Id: description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-Id: description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) allowEmptyValue: true schema: type: string format: uuid example: 283a8c83-625c-43bb-8e5e-ec17e8f3adcc X-BusinessCorrelationId: description: >- The correlation identification as related to business functions and activities. Generally expected to be a GUID. allowEmptyValue: true schema: type: string format: uuid example: d42dae3a-f0f8-467f-a385-7a53c3ee0bd3 X-WorkflowCorrelationId: description: >- The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. allowEmptyValue: true schema: type: string format: uuid example: 2554a29c-802d-42a2-ac82-d6bbe1608ab1 content: text/plain: schema: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false application/json: schema: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false text/json: schema: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false '500': description: Server Error content: text/plain: schema: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false application/json: schema: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false text/json: schema: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: >- The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false components: schemas: AdditionalInfoWireRequestModel: type: object required: - functionType - type - subType - receiveFinancialInstitutionRoutingId properties: originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' branchCode: type: string description: The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true wireInPersonType: type: string description: Was the wire transaction intiated by a person? enum: - 'true' - 'false' nullable: true example: 'true' sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount functionType: type: string description: >- Closed enum of the business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR fee: type: number description: The fee charge amount for a wire format: double example: 10 accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9 ]+$ example: Insurance Payment receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice. These are defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: LTR originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as defined by the Federal Reserve. nullable: true beneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as defined by the Federal Reserve. nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 beneficiaryAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' processorModeType: type: string description: Closed enum that defines the mode of the wire transactions nullable: true enum: - Production - Test example: Test customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service as defined by the Federal Reserve. {3620} tag nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a freeformat description nullable: true entityMatchCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages format: uuid nullable: true example: 234406b7-5402-4f34-8e42-64b55e47ffd6 notes: type: array items: type: string description: >- An array of notes as a free format related to a wire transaction. These notes are not customer facing nor are they added into the wire transfer to the FRB. nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false description: An array of statuses related to a wire nullable: true customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name productDescription: type: string description: A description of a code assigned to a product nullable: true maxLength: 300 originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code feed {5000} faim tag value as defined by the Federal Reserve.. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId feed {5000} faim tag value nullable: true taxId: type: string description: The tax identifier. nullable: true reversalCycleTimeDate: type: string description: The date/time that represents the reversal of a wire transaction nullable: true reversalSourceId: type: string description: The identifier given to a reversal of a wire nullable: true reversalSequenceNumber: type: string description: The sequence number given to a reversal of a wire nullable: true noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Value that identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: Customer alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit alternateAccountId: type: string description: >- The account ID for the the alternate account to be used for the wire transfer nullable: true example: CO543529 alternateShareId: type: string description: The shareID for the altnerate account with a Symitar core nullable: true example: '4004' templateId: type: string description: An ID given to a template created for a wire format: uuid nullable: true example: 1f5b6584-21e4-4404-883a-9a176124dea2 sourceId: type: string description: An indentifier provided by a wire source unique to the actual wire nullable: true maxLength: 200 companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 availableBalanceCalculationCode: type: string description: >- Open enum that specifies of the code that determines the process used to calculate an available balance nullable: true example: '4002' originatorFinancialInstitutionName: type: string description: The name of the originator financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: CAMDEN NATIONAL BANK originatorFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address originatorFinancialInstitutionIdType: type: string description: >- Closed enum spcecfying the Originator financial institution identifer code used for a wire as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorFinancialInstitutionId: type: string description: >- The identifier of the originator financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011201306' beneficiaryFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution as defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE example: LTR beneficiaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true beneficiaryFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' financialInstitutionToFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true beneficiaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true instructionFinancialInstitutionName: type: string description: The name of the instructing financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: UNION SAVINGS BANK instructionFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address instructionFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Instruction financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed instructionFinancialInstitutionId: type: string description: >- The identifier of the instructing financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102502' intermediaryFinancialInstitutionName: type: string description: The name of the intermediary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: HOMETOWN BANK intermediaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true intermediaryFinancialInstitutionIdType: type: string description: >- Closed enum that indicates the Intermediary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed intermediaryFinancialInstitutionId: type: string description: >- The identifier of the intermediary financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102133' intermediaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution as defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE example: LTR intermediaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender currencyExchangeRate: type: string description: The exchange rate for the currency conversion nullable: true example: '74.09' effectiveDate: type: string description: The effective date of a wire format: date-time example: '2020-01-23' companyEmployeeId: type: string description: The identifier assigned to an employee nullable: true example: ABC346029 companyEmployeeName: type: string description: An employees name nullable: true example: Warren McLean companyVerificationId: type: string description: The wire companys identifier for a verifier for the companys wire nullable: true example: TX-0493-8478 companyVerificationName: type: string description: The name of the wire companys verifier for the companys wire nullable: true example: ABC Consulting LLC instructedAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount drawDownCreditFinancialInsitutionAccountId: type: string description: An identifier as related to a specific account nullable: true example: '290382784098' charges: type: array items: type: object properties: order: type: integer description: The order of the charges for a specific wire format: int64 example: 1 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount additionalProperties: false description: Charges description: An array of charges related to a wire nullable: true sourceStatuses: type: array items: type: object properties: name: type: string description: The name specific to a name - value pair nullable: true value: type: string description: The value specific to a name - value pair nullable: true lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true additionalProperties: false description: An array of SourceStatuses nullable: true underThirdPartyControl: type: boolean description: >- Closed enum that indicates whether the wire is under Third Party Control. Can only be set during initial wire creation. Set to False if not specified. enum: - 'true' - 'false' example: 'false' default: 'false' additionalProperties: false description: Full Model of Wire to be Added into the system AdditionalInfoWireUpdateRequestModel: type: object required: - functionType - type - subType - receiveFinancialInstitutionRoutingId properties: originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' branchCode: type: string description: The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true wireInPersonType: type: string description: Was the wire transaction intiated by a person? enum: - 'true' - 'false' nullable: true example: 'true' sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount functionType: type: string description: >- Closed enum of the business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR fee: type: number description: The fee charge amount for a wire format: double example: 10 accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9 ]+$ example: Insurance Payment receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice. These are defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: LTR originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as defined by the Federal Reserve. nullable: true beneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as defined by the Federal Reserve. nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 beneficiaryAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' processorModeType: type: string description: Closed enum that defines the mode of the wire transactions nullable: true enum: - Production - Test example: Test customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service as defined by the Federal Reserve. {3620} tag nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a freeformat description nullable: true entityMatchCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages format: uuid nullable: true example: 234406b7-5402-4f34-8e42-64b55e47ffd6 notes: type: array items: type: string description: >- An array of notes as a free format related to a wire transaction. These notes are not customer facing nor are they added into the wire transfer to the FRB. nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false description: An array of statuses related to a wire nullable: true customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name productDescription: type: string description: A description of a code assigned to a product nullable: true maxLength: 300 originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code feed {5000} faim tag value as defined by the Federal Reserve.. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId feed {5000} faim tag value nullable: true taxId: type: string description: The tax identifier. nullable: true reversalCycleTimeDate: type: string description: The date/time that represents the reversal of a wire transaction nullable: true reversalSourceId: type: string description: The identifier given to a reversal of a wire nullable: true reversalSequenceNumber: type: string description: The sequence number given to a reversal of a wire nullable: true noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Value that identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: GeneralLedger alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit alternateAccountId: type: string description: >- The account ID for the the alternate account to be used for the wire transfer nullable: true example: CO543529 alternateShareId: type: string description: The shareID for the altnerate account with a Symitar core nullable: true example: '4004' templateId: type: string description: An ID given to a template created for a wire format: uuid nullable: true example: 1f5b6584-21e4-4404-883a-9a176124dea2 sourceId: type: string description: An indentifier provided by a wire source unique to the actual wire nullable: true maxLength: 200 companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 availableBalanceCalculationCode: type: string description: >- Open enum that specifies of the code that determines the process used to calculate an available balance nullable: true example: '4002' originatorFinancialInstitutionName: type: string description: The name of the originator financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: CAMDEN NATIONAL BANK originatorFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address originatorFinancialInstitutionIdType: type: string description: >- Closed enum spcecfying the Originator financial institution identifer code used for a wire as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorFinancialInstitutionId: type: string description: >- The identifier of the originator financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011201306' beneficiaryFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution as defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE example: LTR beneficiaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true beneficiaryFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' financialInstitutionToFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true beneficiaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true instructionFinancialInstitutionName: type: string description: The name of the instructing financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: UNION SAVINGS BANK instructionFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address instructionFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Instruction financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed instructionFinancialInstitutionId: type: string description: >- The identifier of the instructing financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102502' intermediaryFinancialInstitutionName: type: string description: The name of the intermediary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: HOMETOWN BANK intermediaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true intermediaryFinancialInstitutionIdType: type: string description: >- Closed enum that indicates the Intermediary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed intermediaryFinancialInstitutionId: type: string description: >- The identifier of the intermediary financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102133' intermediaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution as defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE example: LTR intermediaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender currencyExchangeRate: type: string description: The exchange rate for the currency conversion nullable: true example: '74.09' effectiveDate: type: string description: The effective date of a wire format: date-time example: '2020-01-23' companyEmployeeId: type: string description: The identifier assigned to an employee nullable: true example: ABC346029 companyEmployeeName: type: string description: An employees name nullable: true example: Warren McLean companyVerificationId: type: string description: The wire companys identifier for a verifier for the companys wire nullable: true example: TX-0493-8478 companyVerificationName: type: string description: The name of the wire companys verifier for the companys wire nullable: true example: ABC Consulting LLC instructedAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount drawDownCreditFinancialInsitutionAccountId: type: string description: An identifier as related to a specific account nullable: true example: '290382784098' charges: type: array items: type: object properties: order: type: integer description: The order of the charges for a specific wire format: int64 example: 1 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount additionalProperties: false description: Charges description: An array of charges related to a wire nullable: true sourceStatuses: type: array items: type: object properties: name: type: string description: The name specific to a name - value pair nullable: true value: type: string description: The value specific to a name - value pair nullable: true lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true additionalProperties: false description: An array of SourceStatuses nullable: true underThirdPartyControl: type: boolean description: >- Closed enum that indicates whether the wire is under Third Party Control. Can only be set during initial wire creation. Set to False if not specified. enum: - 'true' - 'false' example: 'false' default: 'false' additionalProperties: false description: >- Full model to update an existing wire transaction. All properties must be present. This is not a patch. Address: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address AddWireStatusRequestModel: required: - processStep - state type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string description: Wires Process Step example: New state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string description: Wires Process Step States example: Ready lastChangedBy: type: string description: >- The user ID of the user that last changed the wire status. This is the User Id which the consumer would like written to the audit as performing the requested service. nullable: true changeApprovalUser: type: string description: >- The User ID of the user that approved the wire status change. This is the User Id which the consumer would like written to the audit as performing the requested service. nullable: true changeIPAddress: type: string description: The IP address that sent the last status change nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time nullable: true example: '2021-01-30T08:30:00Z' comment: type: string description: Freeform remarks regarding the status change nullable: true additionalProperties: false Amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount Charges: type: object properties: order: type: integer description: The order of the charges for a specific wire format: int64 example: 1 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount additionalProperties: false description: Charges FinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true example: Henrico street3: type: string description: The third line of the Street Address nullable: true example: VA 23228 city: type: string nullable: true description: The city for the address stateProvince: type: string nullable: true example: The state or province for the street address postalCode: type: string nullable: true description: The postal code of the address additionalProperties: false MessageStatusDetailModel: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: This is typically the program that generated the status condition nullable: true additionalProperties: false MessageStatusLogModel: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false MessageStatusModel: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false Name: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name OrderBy: required: - columnName type: object properties: columnName: minLength: 1 type: string isAscending: type: boolean sortOrder: maximum: 2147483647 minimum: 1 type: integer format: int32 additionalProperties: false PagingModel: type: object properties: nextOffset: type: integer description: >- The next 'page' number to specify in your next search to get the next results after these. format: int32 example: '2' results: type: integer description: The number of results returned in this result set. format: int32 example: '20' total: type: integer description: The total number of items found in the search results. format: int64 example: '173' ProblemDetails: type: object properties: type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: {} RelatedIncomingWire: type: object properties: wireId: type: string format: uuid wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true additionalProperties: false RestrictionItemsModel: type: object properties: readOnly: type: array items: type: string description: A list of read only authorization for a user nullable: true noAccess: type: array items: type: string description: A list of no access authorization for a user nullable: true hid: type: array items: type: string description: A list of hidden items specific to a user nullable: true additionalProperties: false description: Restriction Item Model RestrictionsModel: type: object properties: items: type: object properties: readOnly: type: array items: type: string description: A list of read only authorization for a user nullable: true noAccess: type: array items: type: string description: A list of no access authorization for a user nullable: true hid: type: array items: type: string description: A list of hidden items specific to a user nullable: true additionalProperties: false description: Restriction Item Model additionalProperties: false description: Restriction Model ScheduleAddModel: type: object properties: expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' additionalProperties: false description: Responsible to hold the values of Schedule Data ScheduleResponseModel: type: object properties: firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' additionalProperties: false ScheduleUpdateModel: type: object properties: expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' additionalProperties: false description: ScheduleBase Model SearchStatusModel: type: object properties: processStep: type: string nullable: true state: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false SearchWireModel: type: object properties: accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 statuses: type: array items: type: object properties: processStep: type: string nullable: true state: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false description: An array of statuses related to a wire nullable: true createStartDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' createEndDate: type: string description: The date a wire was created format: date-time nullable: true example: '2020-01-01' transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name sourceTypes: type: array items: enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FileImport - FinancialInstitutionClerk type: string example: FileImport description: An array of source types nullable: true transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true wireId: type: string description: The identifier given to a specific wire transaction nullable: true example: d6e9628a-7d71-4dcc-bed6-2983624fa670 lowAmount: type: number description: >- A generic amount for the lowest amount for a wire for the search criteria format: double nullable: true example: '15000.00' highAmount: type: number description: >- A generic amount for the highest amount for a wire for the search criteria format: double nullable: true example: '1000000.00' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan institutionId: type: string description: >- The routing id of either the sending financial institution or the receiving financial institution nullable: true example: '011104351' institutionName: type: string description: >- The name of any of the following institutions in a wire record - beneficiary, originator, intermediary, instruction, receiver nullable: true example: Acme Bank id: type: string description: >- An identifier for either the wire identification number or the customer id nullable: true example: C03982983 branchCode: type: string description: The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true returnType: type: string description: Identifies the ReturnType nullable: true enum: - 'True' - 'False' remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'True' - 'False' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' sorting: type: array items: required: - columnName type: object properties: columnName: minLength: 1 type: string isAscending: type: boolean sortOrder: maximum: 2147483647 minimum: 1 type: integer format: int32 additionalProperties: false nullable: true additionalProperties: false description: Search Wire Model SearchWireTemplateModel: type: object properties: templateId: type: string description: A unique identifier for a wire template. format: uuid example: b43983a5-46ed-4526-8ff4-94f7b61cf9eb nullable: true templateName: type: string description: The name of the template as readable by a human being nullable: true example: Payroll Wire for Acme Industries lowAmount: type: number description: >- Sets filtering for the Lowest Amount Range. If highAmount is specified, this must be lower than highAmount. format: double nullable: true example: '100.22' highAmount: type: number description: >- Sets filtering for the Highest Amount Range. If lowAmount is specified, this must be higher than lowAmount format: double nullable: true example: '900.30' accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name wireScheduleType: type: string description: The Reoccuring wire filter. enum: - Reoccuring - NonReoccuring nullable: true example: NonReoccuring scheduleStates: type: array items: type: string enum: - Active - Expired - Suspended example: Active description: An array of schedule states for filtering the results. nullable: true wireName: type: string description: The human readable name of a wire. nullable: true example: Payroll scheduleNextStartDate: type: string format: date description: >- The earlist next date scheduled for a template. If scheduleNextEndDate is also specified, this value must be the same or lower than scheduleNextEndDate nullable: true example: '2024-07-17' scheduleNextEndDate: type: string format: date description: >- The latest next date scheduled for a template. If scheduleNextStartDate is also specified, this value must be the same or higher than scheduleNextStartDate nullable: true example: '2024-07-17' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' additionalProperties: false description: SearchModel for WireTemplate SearchWireTemplateResponse: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false templates: type: array items: type: object properties: userTemplateId: type: string description: The user supplied templateID nullable: true templateId: type: string description: Gets or sets the Template identifier. format: uuid example: b43983a5-46ed-4526-8ff4-94f7b61cf9eb templateName: type: string description: The name of the template as readable by a human being nullable: true example: Payroll Wire for Acme Industries amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name createBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true example: jjones@testbank.com schedule: type: object properties: firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: >- The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: >- The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' additionalProperties: false accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' additionalProperties: false description: An array of template search results nullable: true paging: type: object properties: nextOffset: type: integer description: >- The next 'page' number to specify in your next search to get the next results after these. format: int32 example: '2' results: type: integer description: The number of results returned in this result set. format: int32 example: '20' total: type: integer description: The total number of items found in the search results. format: int64 example: '173' additionalProperties: false description: Wire Search Response SearchWireTemplateResponseModel: type: object properties: userTemplateId: type: string description: The user supplied templateID nullable: true templateId: type: string description: Gets or sets the Template identifier. format: uuid example: b43983a5-46ed-4526-8ff4-94f7b61cf9eb templateName: type: string description: The name of the template as readable by a human being nullable: true example: Payroll Wire for Acme Industries amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name createBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true example: jjones@testbank.com schedule: type: object properties: firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: >- The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' additionalProperties: false accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' additionalProperties: false SourceStatus: type: object properties: name: type: string description: The name specific to a name - value pair nullable: true value: type: string description: The value specific to a name - value pair nullable: true lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true additionalProperties: false Status: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeApprovalUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeIPAddress: type: string description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true statusId: type: string format: uuid nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false StatusRequestModel: type: object properties: processStep: enum: - New - OFAC - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false Step: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string description: The process step order: type: integer description: The process step order format: int32 additionalProperties: false TransactionSearchWireModel: type: object properties: wireId: type: string description: The identifier given to a specific wire transaction format: uuid example: d6e9628a-7d71-4dcc-bed6-2983624fa670 transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 status: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeApprovalUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeIPAddress: type: string description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true statusId: type: string format: uuid nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false createDate: type: string description: >- The Greenwich Mean time/date the wire was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2021-01-30T08:30:00Z' amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true returnType: type: string description: The return type of specific wire if/when applicable nullable: true remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' thirdPartyStatus: enum: - Held - Pending - Approved type: string nullable: true description: >- The third party status of a wire that is under third party control. This describes the state of a wire in the approval process in a third-party system that originated the wire example: Held effectiveDate: type: string description: The date a wire was sent to the Federal Reserve format: date-time nullable: true sendDate: type: string description: The date the wire was initiated format: date-time nullable: true additionalProperties: false description: Search Wire Response Model UpdateWireTemplateModel: type: object properties: userTemplateId: type: string description: The user supplied templateID nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 taxId: type: string description: The tax identifier. nullable: true name: type: string description: The name of the template as readable by a human being nullable: true example: Payroll Wire for Acme Industries description: type: string description: A human readable description nullable: true example: >- Used twice a month to wire payroll for this company on the 15th and last day of each month effectiveDate: type: string description: The beginning date this template can be used as a RFC 7231 Full Date format: date-time example: ' Wed, 21 Oct 2015 07:28:00 GMT' noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Value that identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 branchCode: type: string description: The code that represents the branch for a financial institution nullable: true functionType: type: string description: >- Closed enum of the business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee fee: type: number description: The initial fee for the wire. format: double example: '22.01' accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' availableBalanceCalculationCode: type: string description: >- Open enum that specifies of the code that determines the process used to calculate an available balance nullable: true example: '4002' sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: type: string description: Gets or sets identifies the type of wire transaction nullable: true enum: - Incoming - Outgoing example: Outgoing default: Outgoing paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service. Enumeration is governed by the FRB {3620} nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 originatorFinancialInstitutionIdType: type: string description: >- Closed enum spcecfying the Originator financial institution identifer code used for a wire as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorFinancialInstitutionId: type: string description: >- The identifier of the originator financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011201306' originatorFinancialInstitutionName: type: string description: The name of the originator financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: CAMDEN NATIONAL BANK originatorFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire whose enumeration is goverened by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true beneficiaryAdviceCode: type: string description: Gets or sets the BeneficiaryAdviceCode identifier. nullable: true beneficiaryAdviceRemarks: type: array items: type: string description: Gets or sets the Beneficiary Advice Remarks identifier. nullable: true beneficiaryRemarks: type: array items: type: string description: Gets or sets the Beneficiary Remarks identifier. nullable: true beneficiaryFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution. These values are defined by the FRB nullable: true enum: - LTR - PHN - TLX - WRE example: LTR beneficiaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as per the FRB nullable: true instructedAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount instructionFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Instruction financial institution identifer code used for a wire whose enumeration is goverened by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed instructionFinancialInstitutionId: type: string description: >- The identifier of the instructing financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102502' instructionFinancialInstitutionName: type: string description: The name of the instructing financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: UNION SAVINGS BANK instructionFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionIdType: type: string description: >- Closed enum that indicates the Intermediary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed intermediaryFinancialInstitutionId: type: string description: >- The identifier of the intermediary financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102133' intermediaryFinancialInstitutionName: type: string description: The name of the intermediary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: HOMETOWN BANK intermediaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution as defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE example: LTR intermediaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true intermediaryFinancialInstitutionRemarks: type: array items: type: string description: The intermediary financial institution remarks. nullable: true chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a free format description nullable: true financialInstitutionToFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true drawDownCreditFinancialInsitutionAccountId: type: string description: An identifier as related to a specific account nullable: true example: '290382784098' charges: type: array items: type: object properties: order: type: integer description: The order of the charges for a specific wire format: int64 example: 1 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount additionalProperties: false description: Charges description: An array of charges related to a wire nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true schedule: type: object properties: expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: >- The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' additionalProperties: false description: Responsible to hold the values of Schedule Data transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9 ]+$ example: Insurance Payment productDescription: type: string description: A description of a code assigned to a product nullable: true maxLength: 300 originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code feed {5000} faim tag value as defined by the Federal Reserve.. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId feed {5000} faim tag value nullable: true originatorIdTypeDescription: type: string nullable: true alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit alternateAccountId: type: string description: >- The account ID for the the alternate account to be used for the wire transfer nullable: true example: CO543529 alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name allowEntities: type: array items: type: string description: the Allow Entities. nullable: true shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' alternateShareId: type: string description: The shareID for the altnerate account with a Symitar core nullable: true example: '4004' beneficiaryDrawDownFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryDrawDownFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer code used for a wire whose enumeration is specified by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryDrawDownFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryDrawDownFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address drawDownCreditFinancialInstitutionRoutingId: type: string description: The routing ID of the drawdown credit financial institution nullable: true example: '290382784098' drawDownCreditFinancialInstitutionName: type: string description: The name of the drawdown credit financial institution nullable: true example: Acme Credit Union drawDownFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice. These are defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: LTR drawDownFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true additionalProperties: false description: Model for Updating a WireTemplate UpdateWireThirdPartyStatusResponseModel: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false operationResult: type: boolean additionalProperties: false ViewWireDisclosure: type: object properties: wireDisclosure: type: object properties: issueDate: type: string description: 'The issuance date for wire disclosure. ' format: date example: '2023-11-17' expireTimeDate: type: string description: >- The expiration time-date for wire disclosure. The expiration date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2023-11-20T14:33:20Z' availableDate: type: string description: The available date for wire disclosure nullable: true format: date example: '2023-11-18' state: type: string description: The state of the wire disclosure enum: - New - Cancelled - PrePayment - Transacted nullable: true example: Cancelled branchCode: type: string description: the code that represents the branch for a financial institution nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: GeneralLedger originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address fee: type: number description: The fee charge amount for a wire format: double example: 10 originatorTotalAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount feeEstimateType: type: number description: The fee charge amount for a wire format: double example: 10 contactType: type: string description: enumeration of the method used for the contact enum: - Email - In-Person - Phone nullable: true contactPhoneNumber: type: string description: The contact phone number in +1 format nullable: true example: '+132894839' currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value nullable: true example: USD currencyExchangeRate: type: string description: The exchange rate for currency conversion nullable: true amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount taxes: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount estimateFee: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount estimateTaxes: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount formType: type: string description: the type of wire disclosure form enum: - PrePaymentLocalNoEstA30a - PrePaymentLocalEstFeesA30b - PrePaymentLocalEstTaxesA30c - PrePaymentLocalEstFeesTaxA30d - PrePaymentUSA33 - ReceiptLocalA31 - ReceiptUSA34 - CombinedLocalA32 - CombinedUSA35 nullable: true example: CombinedUSA35 confirmationCode: type: string description: the identifier given as confirmation for a wire disclosure nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryTransferAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount beneficiaryTotalAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount beneficiaryOtherFee: type: number description: The fee charge amount for a wire to the beneficiary format: double example: 10 exchangeRateEstimated: type: boolean description: Was the exchange rate estimated? example: true transferAmountEstimated: type: boolean description: Was the transfer amount estimated? example: false otherFeesEstimated: type: boolean description: Were any other fees estimated? example: false totalAmountEstimated: type: boolean description: Was the total amount estimated example: true pickupName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name pickupAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address languageType: type: string nullable: true description: The language as defined by ISO 639-2 Language code list default: eng example: eng wireId: type: string format: uuid example: 4383d43f-8ea3-4b2d-839d-4534104084a1 additionalProperties: false restrictions: type: object properties: items: type: object properties: readOnly: type: array items: type: string description: A list of read only authorization for a user nullable: true noAccess: type: array items: type: string description: A list of no access authorization for a user nullable: true hid: type: array items: type: string description: A list of hidden items specific to a user nullable: true additionalProperties: false description: Restriction Item Model additionalProperties: false description: Restriction Model messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false additionalProperties: false ViewWireResponse: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false restrictions: type: object properties: items: type: object properties: readOnly: type: array items: type: string description: A list of read only authorization for a user nullable: true noAccess: type: array items: type: string description: A list of no access authorization for a user nullable: true hid: type: array items: type: string description: A list of hidden items specific to a user nullable: true additionalProperties: false description: Restriction Item Model additionalProperties: false description: Restriction Model wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name drawDownCreditFinancialInsitutionAccountId: type: string description: An identifier as related to a specific account nullable: true example: '290382784098' originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine nullable: true example: Deposit alternateAccountId: type: string nullable: true amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount availableBalanceCalculationCode: type: string description: >- Open enum that specifies of the code that determines the process used to calculate an available balance nullable: true example: '4002' functionType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by FED. ENUM[BTR,CTR,CKS,CTP,DEP,DRB,DRC,FFR,FFS,SVC]The business purpose of the wire specific to domestic wires whose enumeration is defined by FED nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR fee: type: number description: The initial fee for the wire. format: double example: '22.01' actualFee: type: number description: >- The actual fee being charged for the wire after business rules are applied format: double example: '13.03' accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryAdviceCode: type: string description: "Identifies the method used to send wire advice\r\nEnum(LTR, PHN, TLX, WRE, HLD). These values are defined by the Federal Reserve" nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: PHN originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryRemarks: type: array items: type: string description: The beneficiary remarks. nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire whose enumeration is goverened by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a freeformat description nullable: true beneficiaryAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true originatorFinancialInstitutionName: type: string description: The name of the originator financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: CAMDEN NATIONAL BANK originatorFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address originatorFinancialInstitutionIdType: type: string description: >- Closed enum spcecfying the Originator financial institution identifer code used for a wire whose enumeration is goverened by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorFinancialInstitutionId: type: string description: >- The identifier of the originator financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011201306' beneficiaryFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution. These values are defined by the FRB nullable: true enum: - LTR - PHN - TLX - WRE example: LTR beneficiaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as per the FRB nullable: true beneficiaryFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer code used for a wire whose enumeration is specified by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' financialInstitutionToFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as per the FRB nullable: true instructionFinancialInstitutionName: type: string description: The name of the instructing financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: UNION SAVINGS BANK instructionFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address instructionFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Instruction financial institution identifer code used for a wire whose enumeration is goverened by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed instructionFinancialInstitutionId: type: string description: >- The identifier of the instructing financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102502' intermediaryFinancialInstitutionName: type: string description: The name of the intermediary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: HOMETOWN BANK intermediaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionRemarks: type: array items: type: string description: The intermediary financial institution remarks. nullable: true intermediaryFinancialInstitutionIdType: type: string description: >- Closed enum that indicates the Intermediary financial institution identifer code used for a wire whose enumeration is goverened by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed intermediaryFinancialInstitutionId: type: string description: >- The identifier of the intermediary financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102133' intermediaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution. These values are defined by the FRB nullable: true enum: - LTR - PHN - TLX - WRE example: LTR intermediaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as per the FRB nullable: true sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' taxId: type: string description: The tax identifier. nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 branchCode: type: string description: The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true wireInPersonType: type: string description: Was the wire transaction intiated by a person? enum: - 'true' - 'false' nullable: true example: 'true' sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true beneficiaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as per the FRB nullable: true currencyExchangeRate: type: string description: The exchange rate for the currency conversion nullable: true example: '74.09' noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Value that identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true effectiveDate: type: string description: The date a wire was sent to the Federal Reserve format: date-time nullable: true sendDate: type: string description: The date the wire was initiated format: date-time nullable: true companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 companyEmployeeId: type: string description: The identifier assigned to an employee nullable: true example: ABC346029 companyEmployeeName: type: string description: An employees name nullable: true example: Warren McLean companyVerificationId: type: string description: The company verification identifier. nullable: true companyVerificationName: type: string description: The name of the company verification. nullable: true instructedAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount processorModeType: type: string description: Closed enum representing the mode of the wire transactions enum: - Production - Test nullable: true example: Test imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true userCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true previousMessageId: type: string description: The identifier given to a wire message nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeApprovalUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeIPAddress: type: string description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true statusId: type: string format: uuid nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false description: The wire statuses. nullable: true charges: type: array items: type: object properties: order: type: integer description: The order of the charges for a specific wire format: int64 example: 1 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount additionalProperties: false description: Charges description: The charges. nullable: true chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender createdBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true createdTimeDate: type: string description: >- The Greenwich Mean time/date the wire was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2021-01-30T08:30:00Z' lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true lastChangedTimeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time nullable: true example: '2021-01-30T08:30:00Z' paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service. Enumeration is governed by the FRB {3620} nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name productDescription: type: string description: A description of a code assigned to a product nullable: true alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code feed {5000} faim tag value as defined by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId for the {5000} faim tag value nullable: true templateId: type: string description: An ID given to a template created for a wire format: uuid nullable: true urc: type: string nullable: true reversalCycleTimeDate: type: string description: The date/time that represents the reversal of a wire transaction nullable: true reversalSourceId: type: string description: The identifier given to a reversal of a wire nullable: true reversalSequenceNumber: type: string description: The sequence number given to a reversal of a wire nullable: true transferDate: type: string description: The date a wire was created format: date-time example: '2022-05-14' workflowSteps: type: object properties: steps: type: array items: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string description: The process step order: type: integer description: The process step order format: int32 additionalProperties: false nullable: true additionalProperties: false sourceStatuses: type: array items: type: object properties: name: type: string description: The name specific to a name - value pair nullable: true value: type: string description: The value specific to a name - value pair nullable: true lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true additionalProperties: false nullable: true sourceId: type: string description: >- An indentifier provided by a wire source unique to the actual wire identifier nullable: true maxLength: 200 underThirdPartyControl: type: boolean description: >- Closed enum that indicates whether the wire is under Third Party Control. Can only be set during initial wire creation. Set to False if not specified enum: - 'true' - 'false' example: 'false' default: 'false' thirdPartyStatus: enum: - Held - Pending - Approved type: string nullable: true description: >- The third party status of a wire that is under third party control. This describes the state of a wire in the approval process in a third-party system that originated the wire example: Held additionalProperties: false description: View Wire Response ViewWireStatus: type: object properties: statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string description: Wires Process Step example: New state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string description: Wires Process Step States example: Ready lastChangedBy: type: string description: >- The user ID of the user that last changed the wire status. This is the User Id which the consumer would like written to the audit as performing the requested service. nullable: true changeApprovalUser: type: string description: >- The User ID of the user that approved the wire status change. This is the User Id which the consumer would like written to the audit as performing the requested service. nullable: true changeIPAddress: type: string description: The IP address that sent the last status change nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time nullable: true example: '2021-01-30T08:30:00Z' comment: type: string description: Freeform remarks regarding the status change nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false nullable: true messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false additionalProperties: false ViewWireTemplateResponse: type: object properties: userTemplateId: type: string description: The user supplied templateID nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 taxId: type: string description: The tax identifier. nullable: true name: type: string description: The name of the template as readable by a human being nullable: true example: Payroll Wire for Acme Industries description: type: string description: A human readable description nullable: true example: >- Used twice a month to wire payroll for this company on the 15th and last day of each month effectiveDate: type: string description: The beginning date this template can be used as a RFC 7231 Full Date format: date-time example: ' Wed, 21 Oct 2015 07:28:00 GMT' noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Value that identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 branchCode: type: string description: The code that represents the branch for a financial institution nullable: true functionType: type: string description: >- Closed enum of the business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee fee: type: number description: The initial fee for the wire. format: double example: '22.01' accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' availableBalanceCalculationCode: type: string description: >- Open enum that specifies of the code that determines the process used to calculate an available balance nullable: true example: '4002' sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: type: string description: Gets or sets identifies the type of wire transaction nullable: true enum: - Incoming - Outgoing example: Outgoing default: Outgoing paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service. Enumeration is governed by the FRB {3620} nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 originatorFinancialInstitutionIdType: type: string description: >- Closed enum spcecfying the Originator financial institution identifer code used for a wire as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorFinancialInstitutionId: type: string description: >- The identifier of the originator financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011201306' originatorFinancialInstitutionName: type: string description: The name of the originator financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: CAMDEN NATIONAL BANK originatorFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire whose enumeration is goverened by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true beneficiaryAdviceCode: type: string description: Gets or sets the BeneficiaryAdviceCode identifier. nullable: true beneficiaryAdviceRemarks: type: array items: type: string description: Gets or sets the Beneficiary Advice Remarks identifier. nullable: true beneficiaryRemarks: type: array items: type: string description: Gets or sets the Beneficiary Remarks identifier. nullable: true beneficiaryFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution. These values are defined by the FRB nullable: true enum: - LTR - PHN - TLX - WRE example: LTR beneficiaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as per the FRB nullable: true instructedAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount instructionFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Instruction financial institution identifer code used for a wire whose enumeration is goverened by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed instructionFinancialInstitutionId: type: string description: >- The identifier of the instructing financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102502' instructionFinancialInstitutionName: type: string description: The name of the instructing financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: UNION SAVINGS BANK instructionFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionIdType: type: string description: >- Closed enum that indicates the Intermediary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed intermediaryFinancialInstitutionId: type: string description: >- The identifier of the intermediary financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102133' intermediaryFinancialInstitutionName: type: string description: The name of the intermediary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: HOMETOWN BANK intermediaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution as defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE example: LTR intermediaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true intermediaryFinancialInstitutionRemarks: type: array items: type: string description: The intermediary financial institution remarks. nullable: true chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a free format description nullable: true financialInstitutionToFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true drawDownCreditFinancialInsitutionAccountId: type: string description: An identifier as related to a specific account nullable: true example: '290382784098' charges: type: array items: type: object properties: order: type: integer description: The order of the charges for a specific wire format: int64 example: 1 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount additionalProperties: false description: Charges description: An array of charges related to a wire nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true schedule: type: object properties: expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: >- The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' additionalProperties: false description: Responsible to hold the values of Schedule Data transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9 ]+$ example: Insurance Payment productDescription: type: string description: A description of a code assigned to a product nullable: true maxLength: 300 originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code feed {5000} faim tag value as defined by the Federal Reserve.. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId feed {5000} faim tag value nullable: true alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit alternateAccountId: type: string description: >- The account ID for the the alternate account to be used for the wire transfer nullable: true example: CO543529 alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name allowEntities: type: array items: type: string description: the Allow Entities. nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: Customer shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' alternateShareId: type: string description: The shareID for the altnerate account with a Symitar core nullable: true example: '4004' beneficiaryDrawDownFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryDrawDownFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer code used for a wire whose enumeration is specified by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryDrawDownFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryDrawDownFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address drawDownCreditFinancialInstitutionRoutingId: type: string description: The routing ID of the drawdown credit financial institution nullable: true example: '290382784098' drawDownCreditFinancialInstitutionName: type: string description: The name of the drawdown credit financial institution nullable: true example: Acme Credit Union drawDownFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice. These are defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: LTR drawDownFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true templateId: type: string description: Gets or sets the Template identifier. format: uuid example: b43983a5-46ed-4526-8ff4-94f7b61cf9eb messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false restrictions: type: object properties: items: type: object properties: readOnly: type: array items: type: string description: A list of read only authorization for a user nullable: true noAccess: type: array items: type: string description: A list of no access authorization for a user nullable: true hid: type: array items: type: string description: A list of hidden items specific to a user nullable: true additionalProperties: false description: Restriction Item Model additionalProperties: false description: Restriction Model createUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true example: jjones@testbank.com createTimeDate: type: string format: date-time description: >- The Greenwich Mean time/date the wire template was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) nullable: true example: '2021-01-19T08:30:00Z' changeTimeDate: type: string format: date-time description: >- The Greenwich Mean time/date the wire template was changed. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) nullable: true example: '2021-01-30T08:30:00Z' changeUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true example: sjohnson@testcu.org additionalProperties: false description: Model for WireTemplate WireApiResponse: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false wireId: type: string description: The identifier given to a specific wire transaction nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true additionalProperties: false description: Wire Response WireDisclosure: type: object properties: issueDate: type: string description: 'The issuance date for wire disclosure. ' format: date example: '2023-11-17' expireTimeDate: type: string description: >- The expiration time-date for wire disclosure. The expiration date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2023-11-20T14:33:20Z' availableDate: type: string description: The available date for wire disclosure nullable: true format: date example: '2023-11-18' state: type: string description: The state of the wire disclosure enum: - New - Cancelled - PrePayment - Transacted nullable: true example: Cancelled branchCode: type: string description: the code that represents the branch for a financial institution nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: GeneralLedger originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address fee: type: number description: The fee charge amount for a wire format: double example: 10 originatorTotalAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount feeEstimateType: type: number description: The fee charge amount for a wire format: double example: 10 contactType: type: string description: enumeration of the method used for the contact enum: - Email - In-Person - Phone nullable: true contactPhoneNumber: type: string description: The contact phone number in +1 format nullable: true example: '+132894839' currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value nullable: true example: USD currencyExchangeRate: type: string description: The exchange rate for currency conversion nullable: true amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount taxes: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount estimateFee: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount estimateTaxes: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount formType: type: string description: the type of wire disclosure form enum: - PrePaymentLocalNoEstA30a - PrePaymentLocalEstFeesA30b - PrePaymentLocalEstTaxesA30c - PrePaymentLocalEstFeesTaxA30d - PrePaymentUSA33 - ReceiptLocalA31 - ReceiptUSA34 - CombinedLocalA32 - CombinedUSA35 nullable: true example: CombinedUSA35 confirmationCode: type: string description: the identifier given as confirmation for a wire disclosure nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryTransferAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount beneficiaryTotalAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount beneficiaryOtherFee: type: number description: The fee charge amount for a wire to the beneficiary format: double example: 10 exchangeRateEstimated: type: boolean description: Was the exchange rate estimated? example: true transferAmountEstimated: type: boolean description: Was the transfer amount estimated? example: false otherFeesEstimated: type: boolean description: Were any other fees estimated? example: false totalAmountEstimated: type: boolean description: Was the total amount estimated example: true pickupName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name pickupAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address languageType: type: string nullable: true description: The language as defined by ISO 639-2 Language code list default: eng example: eng additionalProperties: false WireDisclosureResponse: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false additionalProperties: false description: Wire Disclosure WireSearchResponse: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false wires: type: array items: type: object properties: wireId: type: string description: The identifier given to a specific wire transaction format: uuid example: d6e9628a-7d71-4dcc-bed6-2983624fa670 transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 status: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeApprovalUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit. nullable: true changeIPAddress: type: string description: >- This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time comment: type: string description: Freeform remarks nullable: true statusId: type: string format: uuid nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: >- The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false createDate: type: string description: >- The Greenwich Mean time/date the wire was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2021-01-30T08:30:00Z' amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount sourceType: type: string description: >- Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: enum: - Incoming - Outgoing type: string description: The type of the wire transaction companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name imad: type: string description: >- The wire Input Message Accountability Data provided to an incoming wire nullable: true omad: type: string description: >- The wire Output Message Accountability Data provided to a outgoing wire nullable: true wireSequenceId: type: string description: The sequence identifier given to a specific wire nullable: true returnType: type: string description: The return type of specific wire if/when applicable nullable: true remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK underThirdPartyControl: type: boolean description: >- An indicator of if the wire was generated by a third-party application that has its own approval process. Typically used for commercial wires. example: 'false' default: 'false' thirdPartyStatus: enum: - Held - Pending - Approved type: string nullable: true description: >- The third party status of a wire that is under third party control. This describes the state of a wire in the approval process in a third-party system that originated the wire example: Held effectiveDate: type: string description: The date a wire was sent to the Federal Reserve format: date-time nullable: true sendDate: type: string description: The date the wire was initiated format: date-time nullable: true additionalProperties: false description: Search Wire Response Model description: an array of summarized wires details nullable: true paging: type: object properties: nextOffset: type: integer description: >- The next 'page' number to specify in your next search to get the next results after these. format: int32 example: '2' results: type: integer description: The number of results returned in this result set. format: int32 example: '20' total: type: integer description: The total number of items found in the search results. format: int64 example: '173' additionalProperties: false description: Wire Search Response WireStatusResponse: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string description: Wires Process Step example: New state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string description: Wires Process Step States example: Ready lastChangedBy: type: string description: >- The user ID of the user that last changed the wire status. This is the User Id which the consumer would like written to the audit as performing the requested service. nullable: true changeApprovalUser: type: string description: >- The User ID of the user that approved the wire status change. This is the User Id which the consumer would like written to the audit as performing the requested service. nullable: true changeIPAddress: type: string description: The IP address that sent the last status change nullable: true timeDate: type: string description: >- The Greenwich Mean time/date the wire status was changed, The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time nullable: true example: '2021-01-30T08:30:00Z' comment: type: string description: Freeform remarks regarding the status change nullable: true errors: type: array items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true additionalProperties: false WireThirdPartyStatusRequestModel: required: - thirdPartyStatus type: object properties: thirdPartyStatus: enum: - Held - Pending - Approved type: string description: >- The third party status of a wire that is under third party control. This describes the state of a wire in the approval process in a third-party system that originated the wire. When a wire is initially created by a third party and underThirdPartyControl has been set to 'true', the initial thirdPartyStatus will always be Held. thirdPartyStatus can be moved from held to pending or approved based on the business case. thirdPartyStatus can be set to Held if it is currently set to pending. thirdPartystatus cannot be changed if it is currently 'Approved'. At that point, the wire has passed beyond control of the third party application and into the natural lifecycle of the wire based on the institution configuration. example: Pending additionalProperties: false Workflow: type: object properties: steps: type: array items: type: object properties: processStep: enum: - New - OFAC - Erms - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string description: The process step order: type: integer description: The process step order format: int32 additionalProperties: false nullable: true additionalProperties: false WireDisclosureModel: type: object properties: issueDate: type: string description: 'The issuance date for wire disclosure. ' format: date example: '2023-11-17' expireTimeDate: type: string description: >- The expiration time-date for wire disclosure. The expiration date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) format: date-time example: '2023-11-20T14:33:20Z' availableDate: type: string description: The available date for wire disclosure nullable: true format: date example: '2023-11-18' state: type: string description: The state of the wire disclosure enum: - New - Cancelled - PrePayment - Transacted nullable: true example: Cancelled branchCode: type: string description: the code that represents the branch for a financial institution nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: GeneralLedger originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address fee: type: number description: The fee charge amount for a wire format: double example: 10 originatorTotalAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount feeEstimateType: type: number description: The fee charge amount for a wire format: double example: 10 contactType: type: string description: enumeration of the method used for the contact enum: - Email - In-Person - Phone nullable: true contactPhoneNumber: type: string description: The contact phone number in +1 format nullable: true example: '+132894839' currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value nullable: true example: USD currencyExchangeRate: type: string description: The exchange rate for currency conversion nullable: true amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount taxes: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount estimateFee: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount estimateTaxes: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount formType: type: string description: the type of wire disclosure form enum: - PrePaymentLocalNoEstA30a - PrePaymentLocalEstFeesA30b - PrePaymentLocalEstTaxesA30c - PrePaymentLocalEstFeesTaxA30d - PrePaymentUSA33 - ReceiptLocalA31 - ReceiptUSA34 - CombinedLocalA32 - CombinedUSA35 nullable: true example: CombinedUSA35 confirmationCode: type: string description: the identifier given as confirmation for a wire disclosure nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryTransferAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount beneficiaryTotalAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount beneficiaryOtherFee: type: number description: The fee charge amount for a wire to the beneficiary format: double example: 10 exchangeRateEstimated: type: boolean description: Was the exchange rate estimated? example: true transferAmountEstimated: type: boolean description: Was the transfer amount estimated? example: false otherFeesEstimated: type: boolean description: Were any other fees estimated? example: false totalAmountEstimated: type: boolean description: Was the total amount estimated example: true pickupName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name pickupAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address languageType: type: string nullable: true description: The language as defined by ISO 639-2 Language code list default: eng example: eng wireId: type: string format: uuid example: 4383d43f-8ea3-4b2d-839d-4534104084a1 additionalProperties: false WireTemplateModel: type: object properties: userTemplateId: type: string description: The user supplied templateID nullable: true accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 taxId: type: string description: The tax identifier. nullable: true name: type: string description: The name of the template as readable by a human being nullable: true example: Payroll Wire for Acme Industries description: type: string description: A human readable description nullable: true example: >- Used twice a month to wire payroll for this company on the 15th and last day of each month effectiveDate: type: string description: The beginning date this template can be used as a RFC 7231 Full Date format: date-time example: ' Wed, 21 Oct 2015 07:28:00 GMT' noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Value that identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 branchCode: type: string description: The code that represents the branch for a financial institution nullable: true functionType: type: string description: >- Closed enum of the business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee fee: type: number description: The initial fee for the wire. format: double example: '22.01' accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' availableBalanceCalculationCode: type: string description: >- Open enum that specifies of the code that determines the process used to calculate an available balance nullable: true example: '4002' sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk transactionType: type: string description: Gets or sets identifies the type of wire transaction nullable: true enum: - Incoming - Outgoing example: Outgoing default: Outgoing paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service. Enumeration is governed by the FRB {3620} nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 originatorFinancialInstitutionIdType: type: string description: >- Closed enum spcecfying the Originator financial institution identifer code used for a wire as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorFinancialInstitutionId: type: string description: >- The identifier of the originator financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011201306' originatorFinancialInstitutionName: type: string description: The name of the originator financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: CAMDEN NATIONAL BANK originatorFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire whose enumeration is goverened by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true beneficiaryAdviceCode: type: string description: Gets or sets the BeneficiaryAdviceCode identifier. nullable: true beneficiaryAdviceRemarks: type: array items: type: string description: Gets or sets the Beneficiary Advice Remarks identifier. nullable: true beneficiaryRemarks: type: array items: type: string description: Gets or sets the Beneficiary Remarks identifier. nullable: true beneficiaryFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution. These values are defined by the FRB nullable: true enum: - LTR - PHN - TLX - WRE example: LTR beneficiaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as per the FRB nullable: true instructedAmount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount instructionFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Instruction financial institution identifer code used for a wire whose enumeration is goverened by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed instructionFinancialInstitutionId: type: string description: >- The identifier of the instructing financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102502' instructionFinancialInstitutionName: type: string description: The name of the instructing financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: UNION SAVINGS BANK instructionFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionIdType: type: string description: >- Closed enum that indicates the Intermediary financial institution identifer type as defined by the Federal Reserve. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed intermediaryFinancialInstitutionId: type: string description: >- The identifier of the intermediary financial institution used for a wire nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '011102133' intermediaryFinancialInstitutionName: type: string description: The name of the intermediary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: HOMETOWN BANK intermediaryFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address intermediaryFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice to an institution as defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE example: LTR intermediaryFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true intermediaryFinancialInstitutionRemarks: type: array items: type: string description: The intermediary financial institution remarks. nullable: true chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a free format description nullable: true financialInstitutionToFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true drawDownCreditFinancialInsitutionAccountId: type: string description: An identifier as related to a specific account nullable: true example: '290382784098' charges: type: array items: type: object properties: order: type: integer description: The order of the charges for a specific wire format: int64 example: 1 chargeType: type: string description: >- Closed enum that indicates the entity that is being charged for a wire nullable: true enum: - Sender - Beneficiary - Originator - BeneficiaryOriginator example: Sender amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount additionalProperties: false description: Charges description: An array of charges related to a wire nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true schedule: type: object properties: expireDate: type: string description: The epiration date of the schedule as a RFC 7231 full date nullable: true example: Thurs, 21 Feb 2023 07:28:00 GMT frequency: type: integer description: The frequency of the schedule format: int32 example: 22 frequencyUnits: type: string description: The unit of frequency for the schedule nullable: true enum: - Days - Months - Years - Weekly - SemiMonthly - WeekSkipLast - WeekSkipFirst - BiWeekSkipLast - BiWeekSkipFirst example: Days semiMonthlyFirstDay: type: integer description: The first day of the month for a semi monthly scheduled template format: int32 example: '1' semiMonthlySecondDay: type: integer description: >- The second day of the month for a semi monthly scheduled template format: int32 example: '15' weekDay: type: array items: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday example: Tuesday description: An array of weekdays for scheduled templates nullable: true state: type: string description: Gets or sets State nullable: true enum: - Active - Expired - Suspended example: Expired scheduleOccur: type: integer description: How often the schedule occurs format: int32 example: '3' firstDate: type: string description: Gets or sets First scheduled Transfer Date nullable: true example: '2024-03-05' nextDate: type: string description: The next date the shcedule will trigger nullable: true format: date example: '2024-03-05' additionalProperties: false description: Responsible to hold the values of Schedule Data transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9 ]+$ example: Insurance Payment productDescription: type: string description: A description of a code assigned to a product nullable: true maxLength: 300 originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code feed {5000} faim tag value as defined by the Federal Reserve.. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId feed {5000} faim tag value nullable: true originatorIdTypeDescription: type: string nullable: true alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit alternateAccountId: type: string description: >- The account ID for the the alternate account to be used for the wire transfer nullable: true example: CO543529 alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name allowEntities: type: array items: type: string description: the Allow Entities. nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: Customer shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' alternateShareId: type: string description: The shareID for the altnerate account with a Symitar core nullable: true example: '4004' beneficiaryDrawDownFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryDrawDownFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer code used for a wire whose enumeration is specified by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryDrawDownFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryDrawDownFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address drawDownCreditFinancialInstitutionRoutingId: type: string description: The routing ID of the drawdown credit financial institution nullable: true example: '290382784098' drawDownCreditFinancialInstitutionName: type: string description: The name of the drawdown credit financial institution nullable: true example: Acme Credit Union drawDownFinancialInstitutionAdviceCode: type: string description: >- Closed enum that identifies the method used to send wire advice. These are defined by the Federal Reserve. nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: LTR drawDownFinancialInstitutionAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters each as defined by the Federal Reserve. nullable: true createUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true example: jjones@testbank.com createTimeDate: type: string format: date-time description: >- The Greenwich Mean time/date the wire template was first created. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) nullable: true example: '2021-01-19T08:30:00Z' changeTimeDate: type: string format: date-time description: >- The Greenwich Mean time/date the wire template was changed. The date is expressed in ISO 8601 format (yyyy-mm-ddThh:mm:ss:fffff+/-hh.mm) nullable: true example: '2021-01-30T08:30:00Z' changeUser: type: string description: >- This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate however just audit nullable: true example: sjohnson@testcu.org additionalProperties: false description: Model for WireTemplate WireTemplateResponse: type: object properties: messageStatus: type: object properties: responseCode: type: string description: The code related to message responses nullable: true description: type: string description: >- The description related to the status code in a human readable forma nullable: true messageSource: type: string description: >- The source of the response to a message. This would represent the service provider that carry out the business service for the message nullable: true details: type: array description: The array of details as related to a fault response code items: required: - category - code - description type: object properties: code: type: string minLength: 1 description: The code assigned to a providers statuses category: type: string description: The category assigned to a providers message statuses enum: - Error - Fault - Warning - Overridden - Information description: type: string description: >- The description related to the status code in a human readable format minLength: 1 element: type: string description: >- When an Error or Fault occurs this optional element will contain the element which is causing the condition nullable: true elementValue: type: string description: >- When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition nullable: true location: type: string description: >- This is typically the program that generated the status condition nullable: true additionalProperties: false nullable: true logs: type: array description: The array of logs as related to a response code items: type: object properties: store: description: The store that retains log entries type: string enum: - Local - EL key: type: string description: The key related to a log entry specific to the log store nullable: true additionalProperties: false nullable: true additionalProperties: false templateId: type: string description: A unique identifier for a wire template. format: uuid example: b43983a5-46ed-4526-8ff4-94f7b61cf9eb additionalProperties: false SimplifiedWireRequestModel: type: object properties: originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' branchCode: type: string description: The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true wireInPersonType: type: string description: Was the wire transaction intiated by a person? enum: - 'true' - 'false' nullable: true example: 'true' foreignWireType: type: string description: Is the wire transaction for a foreign entity? nullable: true enum: - 'True' - 'False' example: 'False' sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount functionType: type: string description: >- Closed enum of the business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR fee: type: number description: The fee charge amount for a wire format: double example: 10 accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9 ]+$ example: Insurance Payment receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryAdviceCode: type: string description: Closed enum that identifies the method used to send wire advice nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: LTR originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire whose enumeration is goverened by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 beneficiaryAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true transactionType: type: string description: Gets or sets identifies the type of wire transaction nullable: true enum: - Incoming - Outgoing example: Outgoing default: Outgoing sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' processorModeType: type: string description: Closed enum that defines the mode of the wire transactions nullable: true enum: - Production - Test example: Test customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service. Enumeration is governed by the FRB {3620} nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a free format description nullable: true entityMatchCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages format: uuid nullable: true example: 234406b7-5402-4f34-8e42-64b55e47ffd6 notes: type: array items: type: string description: >- An array of notes as a free format related to a wire transaction. These notes are not customer facing nor are they added into the wire transfer to the FRB. nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false description: An array of statuses related to a wire nullable: true customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name productDescription: type: string description: A description of a code assigned to a product nullable: true maxLength: 300 originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code for the {5000} faim tag value as defined by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId for the {5000} faim tag value nullable: true originatorIdTypeDescription: type: string nullable: true taxId: type: string description: The tax identifier. nullable: true reversalCycleTimeDate: type: string description: The date/time that represents the reversal of a wire transaction nullable: true reversalSourceId: type: string description: The identifier given to a reversal of a wire nullable: true reversalSequenceNumber: type: string description: The sequence number given to a reversal of a wire nullable: true noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: GeneralLedger alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit alternateAccountId: type: string description: >- The account ID for the the alternate account to be used for the wire transfer nullable: true example: CO543529 alternateShareId: type: string description: The shareID for the altnerate account with a Symitar core nullable: true example: '4004' templateId: type: string description: An ID given to a template created for a wire format: uuid nullable: true example: 1f5b6584-21e4-4404-883a-9a176124dea2 beneficiaryDrawDownFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryDrawDownFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer code used for a wire whose enumeration is specified by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryDrawDownFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryDrawDownFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true example: Henrico street3: type: string description: The third line of the Street Address nullable: true example: VA 23228 city: type: string nullable: true description: The city for the address stateProvince: type: string nullable: true example: The state or province for the street address postalCode: type: string nullable: true description: The postal code of the address additionalProperties: false informationRemarks: type: array items: type: string nullable: true drawDownCreditFinancialInstitutionRoutingId: type: string description: The routing ID of the drawdown credit financial institution nullable: true example: '290382784098' drawDownCreditFinancialInstitutionName: type: string description: The name of the drawdown credit financial institution nullable: true example: Acme Credit Union sourceId: type: string description: >- An indentifier provided by a wire source unique to the actual wire identifier nullable: true maxLength: 200 companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 additionalProperties: false description: Simplified Wire Model SimplifiedWireUpdateRequestModel: type: object properties: originatorName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name originatorAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address accountType: type: string description: >- An open/hybrid enum that specifies the type of account as related to a wire. enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Loan accountId: type: string description: An identifier as related to a specific account nullable: true example: '2424' shareId: type: string description: An identifier related to a specific share in Symitar nullable: true example: '0001' branchCode: type: string description: The code that represents the branch for a financial institution nullable: true generalLedgerCostCenter: type: string description: The cost center related to a specific GL account nullable: true generalLedgerProductCode: type: string description: An open enum representing the code assigned to a product in the core nullable: true wireInPersonType: type: string description: Was the wire transaction intiated by a person? enum: - 'true' - 'false' nullable: true example: 'true' foreignWireType: type: string description: Is the wire transaction for a foreign entity? nullable: true enum: - 'True' - 'False' example: 'False' sourceDestinationType: type: string description: Open enumeration of the source destination of a transaction nullable: true officerCode: type: string description: >- Open enumeration of the code assigned to a financial institutions officer nullable: true example: OFC001 amount: type: object properties: value: type: number description: A generic amount format: double example: 100.55 currencyType: type: string default: USD description: The ISO 4217 three character currency type. nullable: true example: USD additionalProperties: false description: An Amount functionType: type: string description: >- Closed enum of the business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - BTR - CTR - CKS - CTP - DEP - DRB - DRC - FFR - FFS - SVC example: CTR fee: type: number description: The fee charge amount for a wire format: double example: 10 accountAnalysisTransactionCode: type: string description: >- The code that represents the account analysis behavior for a specific transaction nullable: true example: '10' feeType: type: string description: >- Closed enum that describes how the wire customer should be charged for the wire. nullable: true enum: - WireFee - Counter - WireFeeCounter example: WireFee type: type: string description: >- Closed enum that describes the type of wire specific to domestic wires nullable: true enum: - FinancialInstitution - FRB - ForeignTransfer example: FinancialInstitution subType: type: string description: >- The business purpose of the wire specific to domestic wires whose enumeration is defined by the FRB. nullable: true enum: - Standard - ReturnRequest - ReversalOfTransfer - Return - PriorDayReturnRequest - PriorDayReturn - DrawDownRequest - DrawDownTransfer - DrawDownFail - Service example: Standard transactionDescription: type: string description: A human readable description for a specific wire transaction nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9 ]+$ example: Insurance Payment receiveFinancialInstitutionRoutingId: type: string description: >- The routing identifier for the receiving financial institution for a wire nullable: true minLength: 9 maxLength: 9 pattern: ^[0-9]+$ example: '011000028' receiveFinancialInstitutionName: type: string description: The name of the receiving financial institution for a wire nullable: true maxLength: 18 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: EAST WEST BANK receiveFinancialInstitutionRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true beneficiaryName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name beneficiaryAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Henrico street3: type: string description: The third line of the Street Address nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: VA 23228 additionalProperties: false description: An Address beneficiaryAdviceCode: type: string description: Closed enum that identifies the method used to send wire advice nullable: true enum: - LTR - PHN - TLX - WRE - HLD example: LTR originatorBeneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. A maximum of 4 items of no more than 35 characters each is allowed as per the FRB nullable: true beneficiaryIdType: type: string description: >- Closed enum that identifies the type of beneificary identifer used for a wire whose enumeration is goverened by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense beneficiaryId: type: string description: >- The identiifer that goes along with the Wire Beneficiary Identifier type nullable: true maxLength: 34 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: '100983750' beneficiaryReference: type: string description: >- A wire reference for the beneficiary for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: B007232890 originatorReference: type: string description: >- A wire reference for the originator for an end to end indentification nullable: true maxLength: 16 pattern: ^[ A-Za-z0-9 ]+$ example: Y00049849 beneficiaryAdviceRemarks: type: array items: type: string pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ description: >- An array of remarks. 1 line of 26 characters, plus up to 5 lines of 33 characters eachas per the FRB nullable: true transactionType: type: string description: Gets or sets identifies the type of wire transaction nullable: true enum: - Incoming - Outgoing example: Outgoing default: Outgoing sourceType: type: string description: Close enum that identifies the source type of the wire request. enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - FinancialInstitutionClerk nullable: true example: FinancialInstitutionClerk internetFinancialInstitutionId: type: string description: >- An identifier given to a financial institutions internet banking application user nullable: true example: '011304300' processorModeType: type: string description: Closed enum that defines the mode of the wire transactions nullable: true enum: - Production - Test example: Test customerId: type: string description: An identifier assigned to a customer nullable: true example: C03982983 paymentNotificationId: type: string description: >- Closed enum identifier that indicates the type of payment notifciation service. Enumeration is governed by the FRB {3620} nullable: true enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' paymentNotificationEmailAddress: type: string description: The email address for payment notification for a wire nullable: true maxLength: 2048 pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$ example: anonymous@lattis.net paymentNotificationName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name paymentNotificationPhoneNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 913-555-1212 paymentNotificationCellNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 816-555-1212 paymentNotificationFaxNumber: type: string description: Attribute to be used for phone types nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: 417-555-1212 paymentNotificationCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Sample Value paymentMethodDescriptions: type: array items: type: string description: An array of payment methods as a free format description nullable: true entityMatchCorrelationId: type: string description: >- An identification provided by the consumer the correlates a group of messages format: uuid nullable: true example: 234406b7-5402-4f34-8e42-64b55e47ffd6 notes: type: array items: type: string description: >- An array of notes as a free format related to a wire transaction. These notes are not customer facing nor are they added into the wire transfer to the FRB. nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - DualControl - Initiate - Process - Custom1 - Custom2 - Custom3 type: string state: enum: - Pending - NextDay - Error - Ready - Incomplete - Suspect - NotSuspect - Overridden - Passed - Required - ContactCustomer - Rejected - NotRequired - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Canceled - Failed - Return - NextDayReturn - Accept - Reply type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false description: An array of statuses related to a wire nullable: true customerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name productDescription: type: string description: A description of a code assigned to a product nullable: true maxLength: 300 originatorIdType: type: string description: >- Closed enum that specifies the originatorIdType code for the {5000} faim tag value as defined by the FRB. enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: DriverLicense originatorId: type: string description: The originatorId for the {5000} faim tag value nullable: true originatorIdTypeDescription: type: string nullable: true taxId: type: string description: The tax identifier. nullable: true reversalCycleTimeDate: type: string description: The date/time that represents the reversal of a wire transaction nullable: true reversalSourceId: type: string description: The identifier given to a reversal of a wire nullable: true reversalSequenceNumber: type: string description: The sequence number given to a reversal of a wire nullable: true noticeTypes: type: array items: type: string enum: - Email - Print - Fax - EmailPrint - None description: >- Identifies the behavior for wire transaction notices. Individual items are governed by a closed enum. nullable: true fundSource: type: string description: Closed enum that specifies the SourceOfFunds nullable: true enum: - Customer - NonCustomer - GeneralLedger example: GeneralLedger alternateCustomerName: type: object properties: common: type: string description: >- The common name which typically is contructed of the First, Middle, and Last Name nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: Dudley F Ault additionalProperties: false description: A common name remittanceTransferRule: type: string description: Closed enum specifying the Remittance Transfer Rule nullable: true enum: - 'true' - 'false' alternateAccountType: type: string description: >- Closed enum that specifies the alternate account type (when indicated). enum: - Deposit - Savings - Loan - TimeDeposit - GeneralLedger - CreditLine - Draft - Share nullable: true example: Deposit alternateAccountId: type: string description: >- The account ID for the the alternate account to be used for the wire transfer nullable: true example: CO543529 alternateShareId: type: string description: The shareID for the altnerate account with a Symitar core nullable: true example: '4004' templateId: type: string description: An ID given to a template created for a wire format: uuid nullable: true example: 1f5b6584-21e4-4404-883a-9a176124dea2 beneficiaryDrawDownFinancialInstitutionId: type: string description: >- The identifier of the beneficiary financial institution used for a wire nullable: true example: '011104351' beneficiaryDrawDownFinancialInstitutionIdType: type: string description: >- Closed enum that specifies the Benificiary financial institution identifer code used for a wire whose enumeration is specified by FRB enum: - Bank - CHIPSPart - DepAcct - Fed - CHIPSId - SwiftId - TaxId - Passport - DriverLicense - AlienRegistration - CorporateId - Oth nullable: true example: Fed beneficiaryDrawDownFinancialInstitutionName: type: string description: The name of the beneficiary financial institution for a wire nullable: true maxLength: 35 pattern: ^[ A-Za-z0-9@_,''"'#+\\d&/=:\-!~;`$%\(\)?<>\. ]+$ example: LIBERTY BANK beneficiaryDrawDownFinancialInstitutionAddress: type: object properties: street1: type: string description: The first line of the Street Address nullable: true example: 9525 Euclid Street street2: type: string description: The second line of the Street Address nullable: true example: Henrico street3: type: string description: The third line of the Street Address nullable: true example: VA 23228 city: type: string nullable: true description: The city for the address stateProvince: type: string nullable: true example: The state or province for the street address postalCode: type: string nullable: true description: The postal code of the address additionalProperties: false informationRemarks: type: array items: type: string nullable: true drawDownCreditFinancialInstitutionRoutingId: type: string description: The routing ID of the drawdown credit financial institution nullable: true example: '290382784098' drawDownCreditFinancialInstitutionName: type: string description: The name of the drawdown credit financial institution nullable: true example: Acme Credit Union sourceId: type: string description: >- An indentifier provided by a wire source unique to the actual wire identifier nullable: true maxLength: 200 companyId: type: string description: The identifier assigned to a wire company nullable: true example: TX-436-987 underThirdPartyControl: type: boolean description: >- Closed enum that indicates whether the wire is under Third Party Control. Can only be set during initial wire creation. Set to False if not specified. enum: - 'true' - 'false' example: 'false' default: 'false' additionalProperties: false description: Simplified Wire Model securitySchemes: Bearer: type: apiKey description: >- JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}" name: Authorization in: header OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: >- https://jxdmz.jackhenry.com/jxchange/identity/authserver/connect/token scopes: {} security: - OAuth2: [] tags: - name: Wire Search description: >- A wire transactions search API - Please note that all enum values are case sensitive servers: - url: https://{API_ENVIRONMENT}/jx-api variables: API_ENVIRONMENT: default: jxdmz.jackhenry.com description: Jack Henry DMZ Test Server