Merchant Upload File Specification
OnlineCustomerSetupForm
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| SchemaVersion | int | Y | Value must be: "3" | |
| CustServID | int | Y | FI ID (MID) of the financial institution assigned by EPS. | |
| CustServName | string | 3-120 | Y | FI customer service name. |
| AdminUserID | long | N | Value can be: "-1" | |
| EntityID | int | Y | Value must be: "-1" | |
| EntityNumber | string | 40 | N | Owning Entity’s ID for the merchant. |
| ID | int | Y | Value must be: "-1" | |
| FormStatus | byte | Y | EPS system use. "0" (default) | |
| Created | dateTime | N | EPS system use. | |
| OriginationType | short | Y | Value must be: "4" | |
| CheckProcessorID | int | Y | FI ID (MID) of the merchant check processor. | |
| ExternalID | string | 255 | Y | FI-generated unique value for the merchant being created within this XML/JSON file. |
| TransactionID | int | N | FI-generated unique value for the merchant being created within this XML/JSON file. | |
| ResellerDisplayName | string | 120 | N | Lookup value from external source. Can be null. |
| ResellerType | byte | Y | Describes the entity type to be boarded. Value must be: "0" | |
| BoardingRefID | string | 20 | N | ID from external source. Accepts alphanumeric, special characters, and spaces. Note: This element is not |
| supported for financial institution merchants. | ||||
| MoneyTransmitter | bool | N | Indicates whether the merchant to board will be a money transmitter. Possible values: "true" (1) "false" (0) (Default) Note: This element is not supported for financial institution merchants. |
CustomerInfo
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| BusinessInfo | Information about your merchant | |||
| LoginName | string | 8-30 | Y | Unique value used to log in to SPB. Must be at least 8 characters long. If a duplicate is found, a numeric value will be appended to the end of the login name, not to exceed 30 characters. Any value over 30 characters or less than 8 characters will cause the file to be rejected. |
| CorporateLegalName | string | 3-120 | Y | Merchant's legal name. This element only allows the ampersand (&) special character in the payload (e.g., JSON or XML bodies). When using XML, ensure characters are properly escaped (e.g., & as &). |
| DBAName | string | 0-120 | N | Name merchant goes by if different from the legal name. This element only allows the ampersand (&) special character in the payload (e.g., JSON or XML bodies). When using XML, ensure characters are properly escaped (e.g., & as &). |
| BusinessStructure | byte | Y | Possible values: "1" (Sole Proprietor) "2" (Partnership) "3" (LLP) "4" (Corporation) "5" (LLC) "6" (S Corporation) "7" (Not For Profit) "8" (Government) | |
| FederalTaxID | string | 9 | Y | Merchant's Federal Tax ID Number. |
| PhysicalAddress1 | string | 255 | Y | Merchant's street address. |
| PhysicalAddress2 | string | 50 | N | Merchant's additional street address. |
| City | string | 50 | Y | Merchant's city. |
| State | string | 2 | Y | Merchant's 2-character state abbreviation. |
| Zip | string | 10 | Y | Merchant's Zip + 4 code. |
| PhoneNumber | string | 12 | Y | Merchant's phone number, formatted as XXX-XXX-XXXX. |
| PhoneNumberExt | string | 6 | N | Merchant's phone number extension. |
| FaxNumber | string | 12 | Y | Merchant's fax number, formatted as XXX-XXX-XXXX. Note: If the merchant does not have a fax number, use a placeholder of all nines (999-999-9999). |
| CustomerServicePhoneNumber | string | 12 | Y | Merchant's customer service phone number, formatted as XXX-XXX-XXXX. |
| CustomerServicePhoneNumberExt | string | 6 | N | Merchant's customer service phone number extension. |
| CustomerContactInfo | Merchant's Contact Information | |||
| Contacts | A list/array of merchant contacts. At least contact name is required. | |||
| Contact | Merchant’s contact person’s information. | |||
| ID | int | Y | Merchant Contact ID. For each contact, the value must start with "1" and for each subsequent contact, the ID should increment sequentially. Example: Contact 1 = "1", Contact 2 = "2", Contact 3 = "3" | |
| Type | byte | Y | Possible values: “1” (Owner), “2” (Director), “3” (Officer), “4” (Primary Contact), “5” (Secondary Contact) | |
| Name | string | 50 | Y | Merchant contact. |
| Title | string | 50 | N | Contact’s title. This element only allows the ampersand (&) special character in the payload (e.g., JSON or XML bodies). When using XML, ensure characters are properly escaped (e.g., & as &). |
| PhoneNumber | string | 12 | Y | Contact's business phone number, formatted as XXX-XXX-XXXX. |
| PhoneNumberExt | string | 6 | N | Contact's business phone number extension. |
| BusinessFaxNumber | string | 12 | N | Contact's business fax number. |
| EmailAddress | string | 50 | N | Contact's email address. |
Segment
A collection of Standard Segments
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| Segment | Standard Segment assignments for this merchant. Note: If merchant segments are included, all three elements must contain values. | |||
| Sector | string | 4000 | N | Merchant's NAICS Sector. |
| Code | string | 10 | N | Merchant's NAICS Industry Code. |
| InternalName | string | 4 | Y | The Segment Internal name used to uniquely identify the Segment Code. Value must be: “0001 NAICS” (NAICS Code) |
Services
This section identifies the EPS transaction processing applications that are available to be set up for an FI merchant.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| ServicesRequested | Select which SmartPay products will be used by this merchant. Note: At least one (RDC, mRDC, ACH or RDN) must be selected. RDN cannot be selected if you select RDC or mRDC. | |||
| RemoteDepositCapture | bool | N | RDC performs courtesy amount recognition (CAR) and legal amount recognition (LAR) of each scanned check, balances the deposit, and repairs the MICR. Possible values: “true” “false” (default) | |
| MobileRemoteDepositCapture | bool | N | mRDC is a mobile offering for the traditional RDC service that provides the ability to deposit a check using a certified mobile device. Possible values: “true” “false” (default) | |
| RemoteDepositNow | bool | N | RDN allows the merchant to perform courtesy amount recognition (CAR) and legal amount recognition (LAR) of each scanned check, balance the deposit, and repair the MICR. Possible values: “true” “false” (default) | |
| ACH | bool | N | Additional ACH process functionality (such as PPD, CCD, TEL and WEB) is available, including check acceptance. Possible values: “true” “false” (default) |
Scanners
Identifies the type(s) of physical terminals used for scanning checks by this merchant, if applicable.
Note: At least one scanner must be added if RDC is selected.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| ID | int | Y | Merchant Scanner ID. For each scanner, the value must start with "0" and for each subsequent scanner, the ID should increment sequentially. Example: Scanner 1 = "0", Scanner 2 = "1", Scanner 3 = "2" | |
| Enabled | bool | Y | Possible values: true (default) false Note: If "True" is entered for 851 Terminal Type ID, the value will be ignored. | |
| Make | int | Y | Possible Terminal Type IDs are: 807 - Panini® Vision X™ 808 - Panini MyVision X™ 805 - Panini I: Deal® 806 - Panini WI: Deal® 715 - RDM® ec7000i® 721 - RDM® ec7500i® 718 - Epson® CaptureOne™ (TM-S1000) 765 - Digital Check® SmartSource® Professional Elite 936 - Digital Check SmartSource Merchant Elite 935 - Digital Check SmartSource Micro Elite 930 - Digital Check SmartSource Value 760 - Digital Check SmartSource Professional 900 - Digital Check TellerScan® TS230 940 - Digital Check CheXpress® 30 951 - Digital Check TellerScan TS240 920 - Digital Check Micro EX 501 - Magtek® MagneSafe Card Swipe 502 - Magtek Dynamag Card Swipe 960 - Canon® CR-L1 965 - Canon CR-120 970 - Canon CR-150 975 - Canon CR-190i II 943 - Digital Check CheXpress® 35 954 - Digital Check CheXpress® TS250 851 - Automated Scanner | |
| MakeName | string | 255 | Y | Description of the scanner manufacturer that was selected. |
| SerialNumber | string | 20 | Y | Serial number of the scanner. |
| TerminalDescription | string | 50 | Y | Auto-populated with Make and MakeName. |
| LocationDescription | string | 50 | Y | The name of the business or location where the scanner will be used. |
| City | string | 4 | Y | City from BusinessInfo tag. |
| State | string | 2 | Y | State from BusinessInfo tag. |
ProcessingConfigOptions
ACHConfigOptions
Options for configuring ACH processing functionality.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| DaysToHoldFundsACHDebits | byte | 3 | Y | Specifies the number of days funds are held before being released for ACH debit transactions. Possible values: 0 (default) |
| DaysToHoldFundsACHCredits | byte | 3 | Y | Specifies the number of days funds are held before being released for ACH credit transactions. Possible values: 0 (default) |
| ACHOptionsAndAdditionalServices | Options for configuring ACH and Additional Services | |||
| ACHCredit | bool | Y | Allow origination of ACH credits. Possible values: true, false (default) | |
| ACHDebit | bool | Y | Allow origination of ACH debits. Possible values: true, false (default) | |
| ACHRefund | bool | Y | Allow refund of a prior ACH transaction. Possible values: true, false (default) | |
| ScheduleRecurringACHCredits | bool | Y | Allow the creation of recurring ACH credit transactions. Possible values: true, false (default) | |
| ScheduleRecurringACHDebits | bool | Y | Allow the creation of recurring ACH debit transactions. Possible values: true, false (default) | |
| InternetWeb | bool | Y | Allows the creation of WEB transactions through SmartPay Biller Direct and SmartPay Express/Integrated SmartPay Express. Possible values: true, false (default) | |
| TelephoneCheck | bool | Y | Allows the creation of one-time or recurring ACH debits via telephone. Possible values: true, false (default) | |
| TelephoneCheckOptions | Notification Options for Telephone Transactions. These options determine how the merchant's customer will be notified about their telephone transaction, if applicable. If TelephoneCheck is set to "true", at least one of the following options must be set to "false": | |||
| HideMerchantNotify | bool | If set to "false", the merchant will notify their customer via mail or fax with the transaction details, in accordance with NACHA rules. Possible values: true, false (default) | ||
| HideEmailNotify | bool | If set to "false", the merchant will notify their customer via email with the transaction details, in accordance with NACHA rules. Possible values: true, false (default) | ||
| HidePostcardNotify | bool | If set to "false", the merchant will notify their customer via a postcard through the mail with the transaction details, in accordance with NACHA rules. Possible values: true, false (default) | ||
| HideRecordedNotify | bool | If set to "false", the merchant will record the phone call and retain the recording for 2 years, in accordance with NACHA rules. Possible values: true, false (default) | ||
| ACHCollectionOptions | In the event of a returned ACH item, EPS can automatically re-present the item to the check writer's bank in order to attempt collection on the face amount, as well as returned-check fee. Information in this section applies only to ACH items. Check 21 items cannot be re-presented. | |||
| SettingsID | long | Y | Default = "0" | |
| ReturnedCheckPresentments | byte | Y | If an ACH item is returned, attempt collection of the Returned-Check Fee up to how many times? Possible values: 0 - Do not re-present the fee amount, 1 - Re-present the fee amount one time, 2 - Re-present the fee amount up to two times, 3 - Re-present the fee amount up to three times. Default = 0 | |
| TimingOfFirstPresentment | byte | Y | First ACH re-presentment will occur how many days following the first return? Possible values: 0 - Immediately following ACH return, 1 - 1 day following ACH return, 2 - 2 days following ACH return, 3 - 3 days following ACH return, 4 - 4 days following ACH return, 5 - 5 days following ACH return, 6 - 6 days following ACH return, 7 - 7 days following ACH return, 8 - 8 days following ACH return, 9 - 9 days following ACH return, 10 - 10 days following ACH return, 15 - 15 days following ACH return, 20 - 20 days following ACH return, 25 - 25 days following ACH return, 30 - 30 days following ACH return. Default = 0 | |
| TimingOfFinalPresentment | byte | Y | Default = "0" | |
| TimeFinalPresentment | bool | Y | Common Paydays: Final ACH re-presentment will automatically coincide with common paydays (e.g., 1st and 15th). Fixed Days: Final ACH re-presentment will occur after a fixed number of days. Possible values: 0 - false (Schedule after a specified number of days), 1 - true (default) (Coincide with common paydays, e.g., 1st and 15th) | |
| FaceAmountRePresentments | byte | Y | If an ACH item is returned, attempt collection on the face amount up to how many times? Possible values: 0 - Do not re-present, 1 - Re-present 1 time, 2 - Re-present up to 2 times. Default = 0 | |
| ReturnedCheckFeeAmount | dec | Y | If you selected one or more returned-check fee attempts, enter the amount to charge check writer. Note: Fees vary by state, so please consult with local collection laws to determine the returned-check fee amount. | |
| DaysBeforeClear | byte | Y | Default = "3" | |
| NotesSpecialInstructions | string | 255 | N | Notes and/or special instructions pertaining to ACH collections. |
CheckFeeSettlement
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| FinancialInstitutionAccount | bool | Y | If true, deposit collected fees into the financial institution's account. If false, deposit collected fees into the merchant's settlement account. Possible values: true, false (default) | |
| ABA | string | 9 | Y | Routing Number |
| Acct | string | 4-17 | Y | Account Number |
RemoteDepositCapture
Options for configuring RDC processing functionality.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| CreateOneDepositPerDay | bool | Y | If true, one deposit total is created for multiple batches per day. When false, each batch is its own deposit. Possible values: true (default), false | |
| BatchAdjustmentTolerance | dec | Y | This setting defines how EPS will handle a deposit when there is a variance between the deposit total submitted by the merchant and the deposit total calculated by EPS. Possible values: $0.00 – EPS will REJECT any deposit with a variance. Value = "0", Unlimited – Any value > 0.00 and <= to 99999999.99. EPS will ADJUST any deposit total with a variance. Value = "9999999999", Set Variance – EPS will adjust any deposit total with a variance of +/- the amount variance set. Value = "000". The default is "0" | |
| EnforceCustomBatchID | bool | Y | If true, makes Custom Batch ID a required field, so that the user-entered ID displays on Create Deposits and Reports screens. Possible values: true, false (default) | |
| EnableDataEntry | bool | Y | If “true”, scanned items will appear on the Data Entry View screen, allowing users to enter additional information for an item. Possible values: true, false (default) | |
| DefaultEndorsement | bool | Y | This election applies only to customers using a supported scanner with an ink jet printer. The scanner can print customer data as defined below, on the center portion of the back of the check. This option cannot be used as an endorsement. If true, Print Time Stamp, Batch#, and Sequence # on the back of each check (default) plus up to 35 characters of optional custom data. If false, the value from “CheckIdentification” element will be used. Possible values: true (default), false | |
| CheckIdentification | string | 255 | N | Rear Printing, custom data printed on the back of each check. If “DefaultEndorsement” is “true”, this field is limited to 35 characters. If “false” the field will accept up to 70 characters. |
| RDMFrankingAlwaysOn | bool | Y | This election applies only to customers using a supported scanner with a franking cartridge. If franking is enabled, the scanner will print "Electronically Processed" on the face of each scanned item. Possible values: true (default), false | |
| ProcessingOptions | Determines which type(s) of RDC transaction(s) the merchant will be processing. At least one RDC processing option must be selected. If you selected both Check21 and ACH ARC, EPS will process all qualified consumer checks as ACH items. | |||
| Check21 | bool | Y | Possible values: true, false (default) | |
| ACHAccountsReveivableConversion | bool | Y | Possible values: true, false (default) | |
| ACHBackOfficeConversion | bool | Y | Possible values: true, false (default) | |
| ACHPointOfPurchaseConversion | bool | Y | Possible values: true, false (default) | |
| EmailNotification | Email notifications are sent to system users by default, provided that the customer's administrator enters an email address during setup. This election allows other interested parties (bank, personnel, managers, etc.) to receive notifications via BCC (blind carbon copy). | |||
| Rejected | bool | Y | EPS rejected the deposit. Possible values: true, false (default) | |
| SentToTransactionProcessing | bool | Y | EPS processed the deposit. Possible values: true, false (default) | |
| NeedsRescan | bool | Y | EPS adjusted the deposit total and processed the deposit. Possible values: true, false (default) | |
| ProcessedWithAdjustment | bool | Y | EPS adjusted the deposit total and processed the deposit. Possible values: true, false (default) | |
| DuplicateItemsInBatch | bool | Y | EPS eliminated duplicated items and processed the deposit. Set to "false" if you are configuring mRDC. Possible values: true, false (default) | |
| RejectedItemsInBatch | bool | Y | EPS rejected the items, adjusted the deposit total, and processed the deposit. Set to "false" if you are configuring mRDC. Possible values: true, false (default) | |
| FromEmailAddress | string | 50 | Y | This option refers to the sender of the email notification. Input whether the notifications will appear to be delivered from the default below or the bank’s/credit union's email. remotedeposit@jackhenry.com (default) |
| InterestedParties | This election allows other interested parties to receive email notifications via “blind carbon copy.” | |||
| EmailAddress | string | 50 | Email address of additional parties to receive notifications. Up to 6 additional addresses are allowed. |
MobileRemoteDepositCapture
Options for configuring mRDC processing functionality.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| CreateOneDepositPerDay | bool | Y | If “True”, one deposit total is created for multiple batches per day. When “False”, each batch is its own deposit. Possible values: true (default), false | |
| BatchAdjustmentTolerance | dec | Y | This setting defines how EPS will handle a deposit when there is a variance between the deposit total submitted by the merchant and the deposit total calculated by EPS. Possible values: $0.00 – EPS will REJECT any deposit with a variance. Value = "0", Unlimited – Any value > 0.00 and <= to 99999999.99. EPS will ADJUST any deposit total with a variance. Value = "9999999999", Set Variance – EPS will adjust any deposit total with a variance of +/- the amount variance set. Value = "000". The default is "0" | |
| EnableDataEntry | bool | Y | If “true”, scanned items will appear on the Data Entry View screen, allowing users to enter additional information for an item. Possible values: true, false (default) | |
| Processing Options | Determines which type(s) of mRDC transaction(s) the merchant will be processing. If you selected both Check21 and ACH ARC, EPS will process all qualified consumer checks as ACH items. | |||
| Check21 | bool | Y | Possible values: true, false (default) | |
| ACHAccountsReveivableConversion | bool | Y | Possible values: true, false (default) | |
| ACHBackOfficeConversion | bool | Y | Possible values: true, false (default) | |
| ACHPointOfPurchaseConversion | bool | Y | Possible values: true, false (default) | |
| AdditionalOptionsAndFeatures | Additional options and features provided | |||
| DefaultPaymentType | Y | Defines how a transaction may have been received. Possible values: "None" (default), "MailedIn", "RetailPOS", "BackOffice" | ||
| VelocityActionACH | byte | Y | Defines what to do with an ACH item that exceeds the limits set for this merchant. Possible values: "0" (Disabled) (default), "1" (Suspend), "2" (Declined), "3" (No Action) | |
| VelocityActionIRD | byte | Y | Defines what to do with a Check21 item that exceeds the limits set for this merchant. Possible values: "0" (Disabled) (default), "1" (Suspend), "2" (Declined), "3" (No Action) | |
| DepositSlipOption | string | Y | For RDC, mRDC, or RDN transactions, specify whether to include Static, Optional, or Required Aux On Us data on deposit slips for all locations. Possible options: "None" (default), "Merchant Optional", "Merchant Required", "Static" | |
| DepositSlipAuxOnUs | string | 15 | Y | This field is required if you select Static as the option. Deposit Slip AuxOnUs. Specify up to 15 numeric digits. |
| AccountingRolesAndPrivileges | This option determines how much reporting functionality the merchant’s users/employees need. | |||
| TurnEditOptions | string | Y | This determines whether a user can edit transactions. If you don’t want all users to be able to edit transactions, set to "Off". Possible values: "On" (default), "Off" | |
| DisplayTransactionSummaryHomePage | string | Y | This option determines whether users have access to the Transaction Summary Report. If you don’t want all users to see reports, set to "Off". Possible values: "On" (default), "Off" | |
| EmailNotification | Email notifications are sent to system users by default, provided that the customer's administrator enters an email address during setup. This election allows other interested parties (bank, personnel, managers, etc.) to receive notifications via BCC (blind carbon copy). | |||
| Rejected | bool | Y | EPS rejected the deposit. Possible values: true, false (default) | |
| SentToTransactionProcessing | bool | Y | EPS processed the deposit. Possible values: true, false (default) | |
| ProcessedWithAdjustment | bool | Y | EPS adjusted the deposit total and processed the deposit. Possible values: true, false (default) | |
| FromEmailAddress | string | 50 | Y | This option refers to the sender of the email notification. Input whether the notifications will appear to be delivered from the default below or the bank’s/credit union's email. Default: remotedeposit@jackhenry.com |
| InterestedParties | This election allows other interested parties to receive email notifications via “blind carbon copy.” | |||
| EmailAddress | string | 50 | Y | Email address of additional parties to receive notifications. Up to 6 additional addresses are allowed. |
SingleSignOn
Note: The single sign-on (SSO) template is required if SSO settings are enabled or added.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| SSOEnabled | bool | Y | If SSO is enabled, this field is required. Possible values: "true", "false" (default) | |
| SSOTemplate | string | 20 | Y | If SSO is enabled, this field is required. Possible values: "NetTeller", "Q2", "Treasury", "OBS", Bottomline |
| SSOEntityId | int | Y | If SSO is enabled, this field is required. Using the lookup table below, enter the corresponding SSOEntityID to the SSOTemplate selected. Lookup Table: OBS, 1300 Q2, 1300 Treasury, 1300 NetTeller, 1300 Bottomline, 1300 | |
| SSOEntityName | string | 20 | Y | If SSO is enabled, this field is required. Using the lookup table below, enter the corresponding SSOEntityName to the SSOTemplate selected. Lookup Table: OBS, NetTellerConsumerCapture Q2, NetTellerConsumerCapture Treasury, NetTellerConsumerCapture NetTeller, NetTellerConsumerCapture Bottomline, NetTellerConsumerCapture |
| SSOCustomerId | string | 40 | Y | If SSO is enabled, this field is required. When the SSO template for NetTeller is selected, the customer's/member’s 12-digit ID for NetTeller should be entered into this field. NOTE: If any other SSO template is selected, a "0" should be entered into this field. |
| SSOLoginFailureURL | string | 200 | Y | If OBS or Bottomline template is selected, this field is required. Assigned by the customer and provided to EPS. This is the static URL that SmartPay Business redirects to when single sign-on fails. |
| SSOLogoutURL | string | 200 | Y | If OBS or Bottomline template is selected, this field is required. Assigned by the customer and provided to EPS. This is the static URL that SmartPay Business redirects to when a user logs out of the system. |
| SSOTimeoutURL | string | 200 | Y | If OBS or Bottomline template is selected, this field is required. Assigned by the customer and provided to EPS. This is the static URL that SmartPay Business redirects to when a user times out due to inactivity. |
| SSOBrandedURL | string | 200 | Y | Possible Value: "false" |
Geolocation
Note: Geolocation actions control whether a remote deposit will be allowed or prevented if the user's device IP location is outside the allowed countries.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| GeolocationService | bool | Y | Enable geolocation options. Enabling this option will assess if the user is scanning a check outside of the United States or U.S territories. Possible values: "On", "Off" (default) | |
| IsAllowed | bool | Y | Possible values: "On", "Off" (default) |
RemoteDepositNow
Options for configuring RDN processing functionality.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| CreateOneDepositPerDay | bool | Y | If “true”, one deposit total is created for multiple batches per day. When “false”, each batch is its own deposit. Possible values: true (default), false | |
| ProcessingOptions | Determines which type(s) of RDN transaction(s) the merchant will be processing. At least one RDN processing option must be selected. If you selected both Check21 and ACH ARC, EPS will process all qualified consumer checks as ACH items. | |||
| Check21 | bool | Y | Possible values: true, false (default) | |
| ACHAccountsReveivableConversion | bool | Y | Possible values: true, false (default) |
Velocity
Note: Velocity is a risk management tool that allows the financial institution to manage risk by placing limits on their merchant's EPS activity. The velocity settings can be applied to merchants processing ACH and/or Check21 transactions via RDC, mRDC, and/or RDN.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| VelocitySetting | This section is used to enter the velocity limits for a specific location (account) or all locations (Merchant Default location). If you are using this feature, the velocity settings may not be set to zero or left blank. All 9s can be entered for an unattainable amount. | |||
| ID | long | Y | If velocity setting is enabled, this field is required. For each velocity setting, the value must start with "1" and for each subsequent setting, the ID should increment sequentially. Example: Velocity setting 1 = "1", Velocity setting 2 = "2", Velocity setting 3 = "3" | |
| Enabled | bool | Y | Indicates whether this setting will be active or not. Possible values: true, false (default) | |
| ApplyAtDefaultLevel | bool | Y | Possible values: true - This setting applies to the merchant default location. false – This setting applies to a location or locations. (default) | |
| SingleTransAmount | dec | Y | If velocity setting is enabled, this field is required. Maximum dollar amount allowed for a single transaction per day. Default = “0.0000” when velocity settings are not enabled | |
| SingleDayCount | int | Y | If velocity setting is enabled, this field is required. Maximum number of items allowed per day. Default = “0.0000” when velocity settings are not enabled | |
| SingleDayAmount | dec | Y | If velocity setting is enabled, this field is required. Maximum dollar amount allowed per day. Default = “0.0000” when velocity settings are not enabled | |
| PeriodCount | int | Y | If velocity setting is enabled, this field is required. Maximum number of items allowed per rolling 14 days period. Default = “0.0000” when velocity settings are not enabled | |
| PeriodAmount | dec | Y | If velocity setting is enabled, this field is required. Maximum amount allowed per rolling 14-day period. Default = “0.0000” when velocity settings are not enabled | |
| Velocity Email Settings | This section allows the FI to input email addresses of those persons that wish to receive a notification when the merchant exceeds their velocity set limits the first time of any given day. | |||
| Enabled | bool | N | When enabled, the FI-level email settings for velocity are emailed. Possible values: true, false (default) | |
| VelocityEmailAddress | string | 50 | Y | If FI-level email settings are enabled, this field is required. Email address of any contact person or persons to receive a notification. |
Settlement Type
Note: Types of transactions to be handled by this merchant - ACH or Check21 - to be considered for velocity exceptions for this velocity setting.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| IRD | bool | Y | Designates whether Check21 transactions will have limits applied by this velocity setting. Possible values: true, false (default) | |
| ACH | bool | Y | Designates which type of ACH transaction the limits apply to. Note: The ACH types should only be set to “true” if this is an ACH-only setting. Note: If the ACH Settlement Type is enabled with a value of "true" or "false", the corresponding SEC code is required with a possible value of "true" or "false". Possible values: true, false (default) | |
| WEB | bool | Y | Possible values: true, false | |
| TEL | bool | Y | Possible values: true, false | |
| RCK | bool | Y | Possible values: true, false | |
| PPD_CCD | bool | Y | Possible values: true, false | |
| POP | bool | Y | Possible values: true, false | |
| BOC | bool | Y | Possible values: true, false | |
| ARC | bool | Y | Possible values: true, false |
OperationType
Type of transaction to set a velocity limit on, if applicable.
Note: Each velocity setting can only contain either the Credit or Debit option. Do not include both.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| IRD | bool | Y | Designates whether Check21 transactions will have limits applied by this velocity setting. Possible values: true, false (default) | |
| ACH | bool | Y | Designates which type of ACH transaction the limits apply to. Note: The ACH types should only be set to “true” if this is an ACH-only setting. Note: If the ACH Settlement Type is enabled with a value of "true" or "false", the corresponding SEC code is required with a possible value of "true" or "false". Possible values: true, false (default) | |
| WEB | bool | Y | Possible values: true, false | |
| TEL | bool | Y | Possible values: true, false | |
| RCK | bool | Y | Possible values: true, false | |
| PPD_CCD | bool | Y | Possible values: true, false | |
| POP | bool | Y | Possible values: true, false | |
| BOC | bool | Y | Possible values: true, false | |
| ARC | bool | Y | Possible values: true, false |
Warning
Gives the FI the ability to be warned when a merchant is within a percentage of the limits set. This is an optional feature. If enabled, each element is required.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| LogWarnings | bool | Y | This option determines whether this warning feature will be used. Possible values: true, false (default) | |
| SingleAmountPercentage | dec | Y | If LogWarnings setting is enabled, this field is required. Single Amount Percentage Warning: Within what percentage of the single transaction amount limit do you want an alert sent? Default = “0.0000” when LogWarnings not enabled | |
| DailyPercentage | dec | Y | If LogWarnings setting is enabled, this field is required. Daily Percentage Warning: Within what percentage of the daily amount and count limit do you want an alert sent? Default = “0.0000” when LogWarnings not enabled | |
| PeriodPercentage | dec | Y | If LogWarnings setting is enabled, this field is required. Period Percentage Warning: Within what percentage of the period amount and count limit do you want an alert sent? Default = “0.0000” when LogWarnings not enabled |
FIAccountInfo - Location/Account information
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| BankAccountInfo | This section links locations to specific bank/credit union accounts and velocity settings. | |||
| Locations | Information regarding all this merchant’s locations/accounts. At least one location/account must be added for this merchant. | |||
| Location | Information regarding this merchant’s Location Name, Routing Number, Account Number, and Account Type. | |||
| ID | int | Y | FI Location ID to be assigned to the specific location. For each location, the value must start with "1" and for each subsequent location, the ID should increment sequentially. Example: Location 1 = "1", Location 2 = "2", Location 3 = "3" | |
| CustomerLocationNumber | string | 50 | N | Optional information associated with the location. |
| DisplayLocationName | bool | N | Enable if the Location Name should appear on the payer’s statement instead of the Corporate/Legal name. This option is only applicable for ACH transactions. Possible values: true, false (default) |
ActualAccounts
Bank/Credit union accounts associated with the merchant and mapped to a virtual account type.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| Settlement | The base account assignment. | |||
| AAID | int | Y | For each AAID, the value must start with "1" and for each subsequent setting, the ID should increment sequentially. Example: AAID setting 1 = "1", AAID setting 2 = "2", AAID setting 3 = "3" | |
| BankName | string | 120 | Y | Location name or number. This element only allows the ampersand (&) special character in the payload (e.g., JSON or XML bodies). When using XML, ensure characters are properly escaped (e.g., & as &). |
| RoutingNumber | string | 9 | Y | Routing Number of the financial institution. Note: Ensure the routing number is valid, even when utilizing a production test entity. |
| AccountNumber | string | 4-17 | Y | Account Number of the financial institution. |
| AccountType | byte | Y | Possible values: 0 (Checking), 1 (Savings), 2 (General Ledger). Default = "0" | |
| AccountTypeName | string | N | Possible values: Checking, Savings, General Ledger (G/L) |
VelocitySettings
Identify the velocity setting associated with this Location, if different from the merchant default setting.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| Setting | ||||
| ID | int | Y | Designated velocity setting ID to be assigned to this specific location. | |
| SecuredCommunication | Financial institution personnel authorized to receive merchant's login credentials and respond to questions regarding this form. | |||
| FIContactName | string | 60 | Y | FI Contact Name. |
| FIEmailAddress | string | 50 | Y | FI Contact Email Address. |
| FIContactPhoneNumber | string | 12 | Y | FI Contact Phone Number, formatted as XXX-XXX-XXXX. |
| FIContactPhoneNumberExt | string | 6 | N | FI Contact Phone Number Ext. |
| FIContactFaxNumber | string | 12 | N | FI Contact Fax Number, formatted as XXX-XXX-XXXX. |
Signature
Signature of the authorized user that submitted this merchant’s setup information, confirming that the information is complete and accurate.
| Data Element | Type | Length | Required | Description |
|---|---|---|---|---|
| SignatureName | string | 60 | Y | Authorized Agent Name. |
| SignatureDate | dateTime | Y | Auto-populates with actual export date. YYYY-MM-DDTHH:MN:SC |