InnoEPay

This Help File Page was last Modified on 05/23/2019

<< Click to Display Table of Contents >>

Navigation:  Accounts Receivable System - The Receivables Module > Receivables - General Maintenance Entries > Payment Gateways >

InnoEPay

This Help File Page was last Modified on 05/23/2019

Microkey Solutions offers InnoEPay as its preferred Payment Gateway provider.

InnoEPay is one of the oldest Payment Gateway providers in the eCommerce industry but it is not a merchant account provider.  

InnoEPay will match any Rates charged by your Company's current Payment Gateway

For most Alarm Companies, it translates into generally lower costs, and much better Payment Gateway features.

 

This InnoEPay Payment Gateway integrates seamlessly with MKMS, and is secure, simple to use, and has plenty of extra features in addition to its basic credit card transaction and check processing functions.

When your Company implements the InnoEPay Payment Gateway, this will be the only Payment Gateway that you'll ever need.

An exception to that would be when there is more than one Bank into which your Company will be making Deposits via InnoEpay transactions.

 

When using InnoEPay as your Company's Payment Gateway and your Company is using more than one Bank for making Deposits via InnoEpay transactions:

In this case, each InnoEPay Payment Gateway will make deposits directly to only one Bank.

Therefore, when your Company is using additional Banks for depositing InnoEpay transactions, your Company will need to get additional keys and have additional Payment Gateways defined - one for each Bank that will get those Receipts..

As those additional Payment Gateways are identified, consider a naming method such as InnoEPay-Bank1, InnoEPay-Bank2, etc., with the actual Bank Name used in each case.

Also, if your Company will tokenize Credit Cards, all Tokens will be based on the default, so the other InnoEPay Payment Gateway will automatically recognize those Token. 

 

The InnoEPay Setup Process:

1.Your Company must sign up directly to use InnoEPay’s Payment Gateway

Go to https://InnoEPay.com - scroll to the bottom of the Home Page - sign up through the Get Started window.  

As part of your registration, they will provide the required Key Code

 

2.Confirm the ePay Company Settings are set appropriately:

a.EPay API - By default, the EPayAPI option is set to True ("T") which allows your Company to use the InnoEPay Payment Gateway.

Setting the EPayAPI option to False ("F") turns off the InnoEPay Payment Gateway.

i.Previously, MKS offered an InnoEPay solution that created a Batch File of Transactions which had to be periodically uploaded to the USAePay Portal (a cumbersome process that was subject to human error).

ii.Now, your Company can use this more integrated and seamlessly implemented InnoEPay Payment Gateway provider, by setting the EPayAPI option to True ("T") and following the directions below.

b.Establish your Company's default Codes for batch numbering (see "Understanding the purpose for the InnoEPay batch number default Codes" discussion below)"  

i.AmCCBatchNumber - This is a InnoEPay batch number field for American Express charges which is initially set to 6.

ii.AllCCBatchNumber - This is a InnoEPay batch number field for all other Credit Card charges which is initially set to 7.

iii.CheckNumberBatch - This is a InnoEPay batch number field for Bank Drafts which is initially set to 8

Note: See the "Batch Number Assignment" discussion in the Receipts chapter for more information about Batch Numbering.

iv.UseCCOnFile - When your Company's Payment Gateway is InnoEPay, and InnoEPay is chosen in the Select Gateway field on the E-Payments Form there will be a Use Credit Card on file Check Box option.

oWhen that box is Checked, the UseCCOnFile option will be set to True ("T"), if not Checked, the UseCCOnFile option will be set to False ("F").

v.ePayKey - Update the ePayKey with the value set in the configuration file "MKSePayService.exe.config"

vi.ePayPin -  Update the ePayPin with the value set in the configuration file "MKSePayService.exe.config"  

oYour Company will receive your specific key and pin from InnoEPay

vii.ePayTranWorkerEnabled - Normally set to Yes ("Y").

viii.ePayBatchWorkerEnabled - Normally set to Yes ("Y").

ix.ePayTokenWorkerEnabled - Normally set to No ("N").

x.ePayStatusWorkerEnabled - Normally set to Yes ("Y").

xi.ePayTransEndPoint - Normally set to "transactions"

xii.ePayStatusEndPoint - Normally set to "transaction/{key}s"

xiii.aPayBaseUrl - Normally set to "https://usaepay.com/api/v2"

xiv.ePayCardTokenEndPoiint - Normally set to "transactions"

xv.ePayTokenCmd - Normally set to "cc:save"

xvi.ResponseTimeout - Normally set to "15"

 

3.Create a Payment Gateway record for InnoEPay (see the "Create a Payment Gateway record for InnoEPay" discussion below).

 

Understanding the purpose for the InnoEPay batch number default Codes:

Set your Company's batch number default Codes to identify what your Company wants to use as a batch number prefix (one digit in length) to:

a)Pre-populate the batch number traditionally assigned to each Receipt transaction entered in the E-Payments screen, and

b)Pre-populate the batch number assigned traditionally assigned to each internally created Receipt transaction posted during the Post Auto Draft process (for those accounts setup for Auto Draft to pay for their recurring billing items).

Note:  This prefix Code assignment method should also be used when manually entering the Batch Number for a Receipt in the Receipts and/or the Receipt Posting Form.  

See the "Batch Number Assignment" discussion in the Receipts chapter for more information about Batch Numbering.

 

These Company Settings Batch Number defaults (i.e., AmCCBatchNumber, AllCCBatchNumber, CheckNumberBatch) are automatically inserted as a prefix, which will then be followed by the number of the Month and Day (e.g., prefix+ '1107' for a transaction posted on November 7th ).

Transactions occur on the Due Date of the Invoice!

 

Processes managed Automatically when using InnoEPay for your Company's Payment Gateway:

Invoices - The pending payments records for the Invoices created by the Post Auto Draft procedure are stored in the epPayBatchDet table.

The epPayBatchDet table will be updated automatically following a modification of an Invoice's Due Date and/or Balance Due.

When a User modifies Due Date of an Invoice created by the Post Auto Draft procedure, the corresponding epPayBatchDet table payment record will be updated with that revised Due Date.

Transactions occur on the Due Date of the Invoice!

If Balance Due of an Invoice created by the Post Auto Draft procedure is changed, the Amount field of the corresponding epPayBatchDet table payment record will be updated with that revised Balance Due.

 

Receipts - When the Balance Due on an Invoice is paid:

The system will create a Receipt record and Allocate that Receipt to the appropriate Invoice.

The Status field in the epPayBatchDet table will change to MODIFIED.

If the Receipt (or a Credit Memo) is Unallocated (see Unallocating Receipts & Invoices), the Status field in the epPayBatchDet table is changed to PENDING.

If the Invoice is deleted, Status field in the epPayBatchDet table is changed to MODIFIED.

If the Invoice is restored (Review Deleted Entities), the Status field in the epPayBatchDet table is reset to PENDING.

If the Bill Payer is changed, then the SubscriberID field will be changed in the epPayBatchDet table.

 

When InnoEPay deposits the funds in your Company's Bank Account for Credit Card charges and Bank Drafts (see Note below), they may post those funds to the MKMS in the form of (up to) three (3) separate Bank Deposits on any given day.

These Bank Deposits (using the batch number default Codes identified in InnoEPay Setup Process 2.; b.; i, ii, iii discussion above) would then properly characterize each type of Deposit transaction as follows (examples are assuming that those transactions were posted on November 7th):

1.Daily Total of American Express funds (AmCCBatchNumber) assuming you have charges funded by American Express: Batch Number  = 61107  

2.Daily Total of All other types of Credit Card funds (AllCCBatchNumber) such as Visa, Debit Card, MasterCard, Diners Club, Discover: Batch Number = 71107

3.Daily Total of Bank Drafts (CheckNumberBatch) paid directly from a Subscriber's Bank Account: Batch Number = 81107

Note: ACH transactions (i.e., Bank Drafts) typically take up to 4 days too "clear"

The batch number that will be assigned to those Receipt transaction records will be based on the Day the Bank Draft was requested, not the day it eventually cleared.  

Should the Bank Draft (Check) Bounce, the associated Receipt record will be canceled automatically.

 

Therefore, your Company could see on each business day:

1.A deposit on your Bank Statement for sum of all the AMEX charges that were settled that day,

2.A deposit on your Bank Statement for the lump sum of all other Credit & Debit Card charges that were settled that day

3.A deposit for the lump sum of all other Bank Drafts funded that day.

 

So, by having the batch number Code with prefixes by type pre-populated: the need to identify those items manually is eliminated, consistency is ensured, and when Reconciling your Bank Statement in MKMS, it is easy to characterize those Deposits. 

We recommend that once these Batch Number options are set, your Company does not change those batch number Codes.

 

Validating your Company's batch number default Code entries:

When you Choose the "Credit Card" payment type tab on the E-Payments screen, the Batch Number will include the prefix for the Selected Credit Card Type, followed by the Month+Day numbers

 

HelpFilesE-Payments-CreditCardTab

E-Payments dialog - Credit Card tab - Batch Number field

 

When you Choose  the “Checkpayment type tab, the same thing occurs - the appropriate prefix for a Check is inserted automatically, followed by the Month+Day numbers

 

HelpFilesE-Payments-CheckTab

E-Payments dialog - Check tab - Batch Number field

 

Create a Payment Gateway record for InnoEPay:

InnoEPay Record Editing View - The details of the InnoEPay Payment Gateway record are displayed below the Navigation Menu at the center (Main Body) Form.

 

HelpFilesInnoEpayPaymentGatewayEncryptedDataEntry

Payment Gateways Form - InnoEPay Record Editing View

 

Define the InnoEPay the InnoEPay Payment Gateway

The InnoEPay Payment Gateway's Name is the only entry required here to "tell" MKMS to enable this InnoEPay processing capability (Login, Password, and Instructions are not required here)

However, other information must be entered in the (automatically installed, but user changeable) MKSePayService.exe.config file which will be located in the C:\Program Files\MKS\ePay folder (or when running Windows® in 64 bit mode, in c:\Program Files(x86)\mks\ePay).

 

Update the MKSePayService.exe.config file:

1.Open a Cmd window (Right-Click the Windows® Start Icon and Choose Run, then type Cmd.

2.Change to the directory representing the version of SQL Anywhere your Company is running.

As an example, type cd C:\Program Files\SQL Anywhere 17\BIN64 and Press Enter.

3.Type dblocate -n and Press Enter.

 

HelpFilesDblocateCommand

 

After a few seconds, the system will display the Server Name and is IP Address (with the Port number shown after the colon).

 

4.Set the IP Address and Port Number by opening the MKSePayService.exe.config file

5.Then, using Notepad: edit the Connection String section by replacing the XXX/.XXX (etc) date with the IP Address and Port Number displayed (as shown above).

 

<connectionStrings>

<clear />

<add name="MKS" connectionString="UID=;PWD=;Host=####.####.####.####:####;DBN=MKMSDefault;Connect Timeout=5" />

</connectionStrings>

 

Edited Connection String (example):

<add name="MKS" connectionString="UID=;PWD=;Host=1192.168.0.9:2638;DBN=MKMSDefault;Connect Timeout=5" />

 

6.Set the ePayKey and ePayPin (shown below are sample values only)

 

<add key="ePayKey" value="So431QK28Ftbd3cGafu1mw6wk603XC8"/>

<add key="ePayPin" value="!nno&Pay"/>

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
These ePayPin and ePayKey entries should also exist in Company Settings

<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

 

7.All other MKSePayService.exe.config file entries in the must remain as installed unless changed by MKS Technical Support.

 

Each Company will receive their correct key values from InnoEPay when they sign up directly at https://InnoEPay.com.

 

Understanding the InnoEPay Payment Gateway Process:

Invoices may be paid manually using the E-Payments option on the Subscribers Form and/or the Invoice Form; and/or by using the Post Auto Draft process.

When using the E-Payments option on the Subscribers Form or the E-Pay option on the Invoice Form, the InnoEPay option is chosen for the Drop-Down Selection List in the Select Gateway field.

 

Also, when using the Post Auto Draft process:

InnoEPay is selected using the Drop-Down Selection List provided in the File Type field.

 

HelpFilesPostAutoDrafts-InnoEpay

 

Unlike other Payment Gateways, when InnoEPay is selected, there are no Other Options presented or required in the Post Auto Draft Form

Once InnoEPay is selected, it should become the default File Type in the Post Auto Draft Form

 

The InnoEPay Process:

Once an Invoice is "Paid" using the InnoEPay Payment Gateway, this is the basic InnoEPay work-flow/process when a Check (or Credit Card) payment is submitted, through the final result:

Note: The ePay Review report will contain the most up-to-date information for all of your Company's InnoEPay Payment Gateway submissions.

 

HelpFiles-ePayReviewDialog

 

1.Pending – after a Check (or Credit Card) payment is submitted to the InnoEPay Payment Gateway the transaction will reflect a pending status until the final submission to the appropriate Processor    

2.Submitted – once the Check (or Credit Card) payment has been submitted to the Processor, the Status within the InnoEPay Payment Gateway will be reflected as Submitted until the transaction is Funded/Settled, or Returned where the processor reports/provides information as to why the transaction will not be funded (e.g., NSF/Account Closed).

 

Transaction Code

Label

Meaning

N

Queued

New Transaction (hasn't been processed yet)

P

Pending

For credit cards, batch hasn't closed yet. For checks, hasn't been sent to Bank yet.

B

Submitted

For checks, sent to bank and void no longer available.

F

Funded

Funded (for checks, the date that the money left the account.)

S

Settled

For credit cards batch has been closed and transaction has settled.

For checks, the transaction has cleared.

E

Error

Transaction encountered a post processing error. Not common.

V

Voided

Check transaction that has been voided

R

Returned

Check transaction that has been returned by the bank (e.g., for insufficient funds)

T

Timed out

Check transaction, no update has been received from the processor in 5 days.

M

Manager Approval Required

Transaction has been put on hold pending manager approval. (checks)

 

Transaction Status Codes, Labels, and Descriptions

3.Final Results:

a.Funded/Settled – the Check (or Credit Card) transaction has been successfully processed and will be paid. You will see:

i.one deposit on your Bank Statement for the sum of the AMEX Credit Card charges that were settled that day,

ii.one deposit for a lump sum of all other Visa, Debit, MasterCard, Diners Club, Discover Credit Card charges that were settled that day, and

iii.one lump sum deposit for all other Bank Drafts settled that day

b.Returned – the Check (or Credit Card)  transaction will not be funded so your Company will need to know the reason (e.g., NSF/Account Closed - see the list of Returned Codes below)

Note: If your Company has been approved for expedited funding, any returned items for which they have already received funding will be reversed.

 

When a Check payment transaction will not be funded, your Company will be provided with the Reason it was Returned [e.g., NSF ("R012"), Account Closed ("R02")]

 

Response

Reason

Returned

R01: Insufficient Funds

Returned

R02: Account Closed

Returned

R03: No Account/Unable to Locate Account

Returned

R04: Invalid Account Number

Returned

R06: Returned per Originating Depository Financial Institution's Request

Returned

R07: Authorization Revoked by Customer

Returned

R08: Payment Stopped

Returned

R10: Customer Advises not Authorized

Returned

R16: Account Frozen

Returned Codes