pub:ach_installation
Differences
This shows you the differences between two versions of the page.
Previous revision | |||
— | pub:ach_installation [2025/05/27 18:28] (current) – [Work with Spool Map Fields] kkramer | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== ACH iPayment Solutions | ||
+ | < | ||
+ | [[start# | ||
+ | ===== Work with ACH Definitions ===== | ||
+ | Select option 1 from iPayment main menu to see the existing ACH definitions or to create a new ACH definition. | ||
+ | {{pub: | ||
+ | To create the ACH definition, press F6=Add: | ||
+ | {{pub: | ||
+ | * **ACH Definition** : | ||
+ | * **ACH Application **: | ||
+ | * **Process for Payees**: process some specified or all payees. There are 02 valid values: *ENROLLED or *ALL. If the selection is *ENROLLED, you must enroll the payees you want to processed when the merge runs (see Enroll the Payees into ACH Definition). If the selection is *ALL, then all payees will be processed when the merge runs. To specify a map field is Payee ID, select function DPAYEEID for Function field | ||
+ | * **Database Connection** : | ||
+ | * **ACH Output File and Library**: | ||
+ | * **Overwrite if exist** : specify whether overwrite the output file if it exists | ||
+ | * **Send Remittance Notification**: | ||
+ | |||
+ | ===== Work with Spool Map Fields ===== | ||
+ | From screen ‘Work with ACH Definitions’ (AC1000C1), select option 8=Work with Spool map fields to work with spool mapped fields, or from screen ‘Maintain an ACH Definition’ (AC1000R5), press F8=Work w/ Spool Map Fields. | ||
+ | {{: | ||
+ | To add a new map field, press F6=Add | ||
+ | {{: | ||
+ | |||
+ | * Map field name : enter the map field name | ||
+ | * Function : | ||
+ | |||
+ | | **Function** | **Description** | | ||
+ | |*NONE | The merge process will ignore the field | | ||
+ | |ACHAPP |This field will contain the ACH application name (which contain your company’s bank information)| | ||
+ | |BEFDATE | ||
+ | |BORGDFI | ||
+ | |BSECCODE |Standard Entry Class Code. Identifies the entries in the batch. Common standard entry class codes are **PPD** (Prearranged Payments and Deposit entries) for consumer items, **CCD** (Cash Concentration and Disbursement entries), **CTX** (Corporate Trade Exchange entries) for corporate transactions, | ||
+ | |BSRVCLS | ||
+ | |DCHECKAMT | ||
+ | |DCHECKAMT* |Transaction amount in dollars with two decimal places. This field is used for a multiple lines of spool text (block text)| | ||
+ | |DCHECKNBR |Check number or DFI Account Number for single line of spool text| | ||
+ | |DCHECKNBR*|Check number or DFI Account Number for multiple lines of spool block text| | ||
+ | |DPAYEEACC |Bank account number of payee for single line of spool text| | ||
+ | |DPAYEEACC*|Bank account number of payee for multiple lines of spool block text| | ||
+ | |DPAYEEID | ||
+ | |DPAYEEID* |Payee ID for multiple lines of spool block text| | ||
+ | |DPAYEENAM*|Payee name for single line of spool text| | ||
+ | |DPAYEENAME |Payee name for multiple lines of spool block text| | ||
+ | |DPAYTYPE | ||
+ | |DPAYTYPE* |Payment type code. Input ‘R’ for recurring payments, and ‘S’ for a single-entry payment. This field is used for a multiple lines of spool text (block text)| | ||
+ | |DTRNCODE | ||
+ | |DTRNCODE* |Same as DTRNCODE but it is used for multiple lines of block text| | ||
+ | |HBANKNAME |Your company’s bank name| | ||
+ | |HBNKTRNS# |Routing transit number of your company’s bank.| | ||
+ | |HPAYORID | ||
+ | |HPAYORNAME |Your company name| | ||
+ | * Spool File Data Location: enter the spool text location. Press F2=Data Map to assist you fill in spool text location by referring to data location of spool file. | ||
+ | |||
+ | ===== Work with Database Map Fields ===== | ||
+ | Beside Spool Map Fields, ACH definition can communicate with external database to create ACH transactions. By specifying a Database Connection for ACH Definition, ACH will know what database fields are used. | ||
+ | {{: | ||
+ | In order to work with Database Connections, | ||
+ | |||
+ | When finished adding map fields, you can define the conditions to select some records from database, select option **9=Conditions** from screen Work with Database Connections. | ||
+ | {{: | ||
+ | |||
+ | ===== Enroll the Payees into ACH Definition ===== | ||
+ | In order to enroll the payees into ACH definition, select option 12=Work with Payees from screen Work with ACH Definitions (AC1000C1) or press F9=Work w/ Payees from screen Maintain an ACH Definition (AC1000R5) | ||
+ | {{: | ||
+ | In this screen, you will see who are enrolled for the current ACH Definition. | ||
+ | |||
+ | To remove the payees from enroll list, select option 4=Unenroll | ||
+ | |||
+ | To create a new Payee, press F6=Create. You also can create new Payee from Work with Payees | ||
+ | |||
+ | To enroll more payees, press F8=Enroll Payees, you will see the list of defined payees who are not enrolled, select option 1 on the payees from list you want to enroll and press Enter | ||
+ | {{: | ||
+ | |||
+ | ====== Work with ACH Applications | ||
+ | < | ||
+ | [[start# | ||
+ | |||
+ | ===== Work with ACH Applications ===== | ||
+ | |||
+ | This screen allows users to view, edit, copy, delete, or rename Automated Clearing House (ACH) payment applications. Each row represents a configured ACH Application that can be managed. | ||
+ | {{pub: | ||
+ | **Main Columns:** | ||
+ | | **Column** | **Description** | | ||
+ | |Option | Enter an action option (e.g., 2, 3, 4, 7) for the respective ACH Application| | ||
+ | |ACH Application |Application Name – unique identifier for the ACH configuration| | ||
+ | |Description | ||
+ | |Creation/ | ||
+ | **Available Actions:** | ||
+ | | **Option** | **Function** | **Description** | | ||
+ | |2 | Edit |Modify an existing ACH application| | ||
+ | |3 | Copy |Duplicate an existing application with a new name| | ||
+ | |4 | Delete |Remove the application from the system| | ||
+ | |7 | Rename |Change the name of an existing application| | ||
+ | | **Column** | **Description** | | ||
+ | **Function Keys:** | ||
+ | | **Key** | **Action** | **Description** | | ||
+ | |F3 | Exit |Return to the previous menu| | ||
+ | |F5 | Refresh |Reload the screen data| | ||
+ | |F6 | Add |Create a new ACH application entry| | ||
+ | ===== Maintain an ACH Application ===== | ||
+ | This screen allows users to configure or maintain the ACH file definitions for a given ACH Application. The structure follows the standard NACHA file format, including: | ||
+ | * File Header Record | ||
+ | * Batch Header Record | ||
+ | * Entry Detail (not shown here but linked via F18) | ||
+ | {{pub: | ||
+ | **Section 1: ACH File Header** | ||
+ | | **Field** | **Description** | **NACHA Reference** | | ||
+ | | Payor Company ID |10-digit unique identifier of the originating company |File Header Record, Field 1 | | ||
+ | | Payor Company Name |Legal name of the originating company (e.g., Performance Contractors)|File Header Record, Field 2 | | ||
+ | | Payor Bank Transit# |Bank’s routing transit number (RTN)|File Header Record, Field 3 | | ||
+ | | Payor Bank Name |Optional field for audit tracking |File Header Record, Field 4 | | ||
+ | | Bank Trace Number|10-digit unique identifier of the originating company |Optional | | ||
+ | | File ID Modifier |1-character code to differentiate multiple files per day (e.g., A, B, C)|File Header Record, Field 11| | ||
+ | | File Creation Date / Time |Date & Time when the file is generated (YYMMDD, HHMM)|File Header Record, Field 5 | | ||
+ | **Section 2: ACH Batch Header** | ||
+ | | **Field** | **Description** | **NACHA Reference** | | ||
+ | | **Company Entry** | ||
+ | |** Originating DFI ID** |First 8 digits of the ODFI’s RTN (DFI = Depository Financial Institution)|File Header Record, Field 9 | | ||
+ | | **Standard Entry Class** |Code representing the type of transactions, | ||
+ | | **Transaction Code** |Code for transaction type: **22** Deposit destined for a Checking Account **23** Prenotification for a checking credit **24** Zero dollar with remittance into Checking Account **27** Debit destined for a Checking Account **28** Prenotification for a checking debit **29** Zero dollar with remittance into Checking Account **32** Deposit destined for a Savings Account **33** Prenotification for a savings credit **34** Zero dollar with remittance into Savings Account **37** Debit destined for a Savings Account **38** Prenotification for a Savings debit **39** Zero dollar with remittance into Savings Account | ||
+ | | **No. records of batch** | Number of entry detail records included in a batch |Batch Control Record | | ||
+ | **Section 3: Processing Control** | ||
+ | | **Field** | **Description** | | ||
+ | |**Descriptive Date** | Text description of the file creation date (for reference)| | ||
+ | |**Service Class Code** |Classifies transaction: | ||
+ | |**Effective Entry Date** |Date when entries are intended to post (YYMMDD)| | ||
+ | |**Prefix of ACH Files** |Prefix character (e.g., Z) used when naming the file in IFS| | ||
+ | |**Hold Processing** |Set to Y to hold processing (i.e., prevent file from transmitting), | ||
+ | **Navigation & Function Keys** | ||
+ | | **Key** | **Function** | | ||
+ | |F3 | Exit to previous menu| | ||
+ | |F4 |Prompt field values (help)| | ||
+ | |F10 |Save current ACH definition| | ||
+ | |F12 |Cancel without saving| | ||
+ | |F18 |Go to transaction records (Entry Detail)| | ||
+ | |F20 |View generated ACH files| | ||
+ | |||
+ | |||
+ | |||
+ | ====== Work with ACH Files Option 3 ====== | ||
+ | < | ||
+ | [[start# | ||
+ | |||
+ | From iPayment menu, select item 3. Work with ACH Files. | ||
+ | {{pub: | ||
+ | **8=ACH Transactions** | ||
+ | {{pub: | ||
+ | View the transactions of ACH File. In this screen, you will see the detail of payment amount, check number and bank account of each Payee. | ||
+ | **5=Display** | ||
+ | {{pub: | ||
+ | Select this option to see the detail of an ACH file, this information will be used to create ACH output file | ||
+ | **15=Process** | ||
+ | {{pub: | ||
+ | Select this option to output ACH file to a transmission file. Only ACH Files with status RLS can be processed. When you press Enter, a pop up screen will be shown to ask the location of output file, leave these field blank if you want to use the settings in ACH Definition. | ||
+ | **18=Output Files** | ||
+ | Use this option to see the transmission files which were created by this ACH File. | ||
+ | {{pub: | ||
+ | **Subset ACH Files** | ||
+ | |||
+ | In order to select some ACH files which match some condition, you can use function Subset by press **F17=Subset** from screen **Work with ACH Files**. | ||
+ | |||
+ | ====== Work with Database Connections | ||
+ | < | ||
+ | [[start# | ||
+ | |||
+ | In order to work with Database Connections, | ||
+ | {{: | ||
+ | Press F6=Add to create a new database connection | ||
+ | {{: | ||
+ | * DB Connection : | ||
+ | * Host name/ | ||
+ | * File and Library : enter the name of database and its library | ||
+ | Press F10 to save.\\ | ||
+ | Currently, only local database is supported, therefore all fields of Settings for remote host will be blank\\ | ||
+ | After creating a new database connection, you will want to add the map fields into it. \\ | ||
+ | **Select option 8=Work with Map Fields** | ||
+ | {{: | ||
+ | {{: | ||
+ | Press F6=Add to add a new map field which maps to a database field. | ||
+ | {{: | ||
+ | Press F4=Prompt to select a database field from list. You also need to assign a Function for the field. See Function of Work with Spool Map Fields \\ | ||
+ | |||
+ | When finished adding map fields, you can define the conditions to select some records from database, select option **9=Conditions** from screen Work with Database Connections. | ||
+ | {{: | ||
+ | |||
+ | ====== Work With Payees | ||
+ | < | ||
+ | [[start# | ||
+ | |||
+ | ===== Work with Payees ===== | ||
+ | From main menu, select option 5. Work with Payees | ||
+ | {{: | ||
+ | Press F6 to define new Payee information | ||
+ | {{: | ||
+ | * **Payee ID** : This ID is mandatory and must be unique. | ||
+ | * **Payee Name** : The name of Payee | ||
+ | * **Address** : | ||
+ | * **City** : | ||
+ | * **State** : | ||
+ | * **Zip Code** : The zip code of Payee | ||
+ | * **Bank name** : Enter the bank name of Payee’s account | ||
+ | * **Bank Transit Number** : Enter the routing transit number of Payee’s bank. Please consult your bank for this value | ||
+ | * **Payee Account Number**: Enter the account number of Payee | ||
+ | * **Notification Email** : Enter email address of Payee to receive the remittance notification | ||
+ | * **Send Mail Notification** : | ||
+ | * **Notification Fax** : Enter the fax number of Payee | ||
+ | * **Send Fax Notification** : | ||
+ | |||
+ | ===== Merge ACH Definition with Spool File ===== | ||
+ | From ACH Definitions list, select option 15=Merge with Spool file to merge the ACH Definition with spool file. | ||
+ | {{: | ||
+ | {{: | ||
+ | After merge with spool file, you can see the output transactions by press F8=Work with Transactions from screen AC1000C1 (or select menu item 3. Work with ACH Files from iPayment menu). | ||
+ | {{: | ||
+ | After merged, the status of transaction is RLS as default, unless you change it by specify Y at Hold processing in screen **Maintain an ACH Application.** | ||
+ | |||
+ | **Note:** | ||
+ | * Each spool file is only merged at once, and if you want to merge a spool file again, you must either delete the transaction of that spool file or process it (its status is PRC) | ||
+ | * In order to see what spool file a transaction is created from, select option 9=Mrg Spool Files. If Mrg Spool Files is empty, it means the transaction is created by merge ACH definition with an external database. | ||
+ | |||
+ | ====== Purge ACH Transactions | ||
+ | < | ||
+ | [[start# | ||
+ | |||
+ | To purge the transactions, | ||
+ | {{: | ||
+ | * From Date and To Date : select the creation date of ACH transactions | ||
+ | * Merged by User : purge the transactions which were created by a user | ||
+ | * Transaction Status : specify the status of transactions | ||
+ | * Remove ACH Output Files : specify to remove or retains the transmission files which were accompanied with the transactions. | ||
+ | |||
+ | ====== Merge ACH Definition with Database | ||
+ | When a DB connection was defined in ACH Definition, you can merge it by select option 19=Merge with Database, or you also can merge with some external database by selecting Opt 10 or API command IMRGACHDB. | ||
+ | {{: | ||
+ | |||
+ | ====== Merge ACH Definition with Spool File Option 11 ====== | ||
+ | From ACH Definitions list, select option 15=Merge with Spool file to merge the ACH Definition with spool file, or use Opt 11 or API command IMRGACHSPL. | ||
+ | {{: | ||
+ | {{: | ||
+ | After merge with spool file, you can see the output transactions by press F8=Work with Transactions from screen AC1000C1 (or select menu item 3. Work with ACH Files from iPayment menu). | ||
+ | {{: | ||
+ | After merged, the status of transaction is RLS as default, unless you change it by specify Y at Hold processing in screen **Maintain an ACH Application.** | ||
+ | |||
+ | **Note:** | ||
+ | * Each spool file is only merged at once, and if you want to merge a spool file again, you must either delete the transaction of that spool file or process it (its status is PRC) | ||
+ | * In order to see what spool file a transaction is created from, select option 9=Mrg Spool Files. If Mrg Spool Files is empty, it means the transaction is created by merge ACH definition with an external database. | ||
+ | |||
+ | ====== Work with Selected Access Groups Option 15 ====== | ||
+ | You can assign the authority to some users or some groups to have permissions on some function by set up Selected Access Authorization. By default, users with *SECOFR permission can access this menu. | ||
+ | |||
+ | There are 04 permissions mainly: Read, Update, Write and Execute in respectively. The permission Write will override Read and Update, and the permission Update will override Read. | ||
+ | |||
+ | Firstly, you need to define a Selected Access Groups. From iPayment menu, select item 15. Work with Selected Access Groups | ||
+ | |||
+ | {{: | ||
+ | {{: | ||
+ | Press F6=Add to add a new group. | ||
+ | |||
+ | Select option 12=Work with Users to add or remove some user from group. | ||
+ | |||
+ | ====== Work with Selected Access Groups Option 20 ====== | ||
+ | After defining a group, you will assign the permissions for the group by select menu item 20. Selected Access Authorization. | ||
+ | {{: | ||
+ | There are 08 modules you can set the access authorization. Select one of the modules by option 1, then hit Enter | ||
+ | {{: | ||
+ | In the screen Work with Selected Access User/Group, you can add a Group or a particular user. | ||
+ | To add a Group, press F8=Add a Group. | ||
+ | {{: | ||
+ | Enter the group name and assign the permissions on Group | ||
+ | |||
+ | To add a user profile, press F6=Add a User | ||
+ | |||
+ | {{: | ||
+ | Enter the user ID and assign the permissions on User | ||
+ | |||
+ | |||
+ | < | ||
+ | [[start# | ||
+ | |||
+ | \\ | ||
+ | \\ |