Custom payment gateway

If you choose not to use these previously described gateways, you can create a custom credit card gateway. The same connection parameters that are available for a Payflow Pro gateway are also available for a custom gateway. This includes all of the authorization modes and settings on the AR/Cash Credit Card Authorization window.

  • Web: A .NET developer can write a custom gateway for iMIS for the web. Templates and documentation are available from iMIS Community's SDK Center.
  • Advanced Accounting Console: An Xtender developer can use Visual Basic to write a custom gateway for the Advanced Accounting Console. Templates and documentation are available from the iMIS Support community under Extension Products. Instructions for customizing the gateway are in the documentation and the control files. The Xtender developer must define and carefully document which of the fields should be populated, if any, and for what purpose.

Before implementing a custom gateway, the developer must install the new application in a test environment. The application must be installed on each Advanced Accounting Console workstation from which payments are entered.

After the custom gateway application is installed you must:

  1. Create a new Credit Card Authorization account.
  2. Set up a Cash Account (AR/Cash > Set up table > Tables > Cash Accounts) for a Credit Card or Debit Card that uses the newly defined Credit Card Authorization account.

To configure iMIS to use an Xtender application that a developer has created for a custom credit card gateway, you must set up a credit card authorization account.

Enter gateway information through the Advanced Accounting Console. You can also set up multiple gateways in the Advanced Accounting Console. Do the following to set up a gateway authorization account:

  1. In Advanced Accounting Console, go to Finance > Options > Configure accounting options > Credit Card Auth.
  2. Click New and select a gateway from the Gateway drop-down list.

    3. Note: Once you save a card authorization account, you cannot change the Gateway field.

  3. Specify the authorization type: Manual Authorization (direct debits), Immediate Authorization (credit cards), or Deferred Authorization.
  4. Enter an Account Code. This value displays in the Select a Value window that is displayed when you use the lookup icon on the CC Auth Account field on the Cash accounts (Finance > Options > Set up tables > Cash accounts) setup page. This value cannot be changed once the record is saved.

    5. Note: When entering gateway information for iATS or SecurePay, you must use a pre-defined Account Code. For iATS, enter IATS. For SecurePay, enter SECUREPAY. These codes must match the entry in the web.config file. Read more information about modifying the web.config file for a gateway Account Code.

    Note: Once you save a card authorization account, you cannot change the Account Code field.

  5. Enter an Account description, which will appear under the CC Auth Account field on the Set up cash accounts window.
  6. Enter a meaningful description for the authorization account in the Account description field. This information displays as read-only data on the CC Auth Account field on the Cash accounts setup page.
  7. Enter a Host URL. You will receive the Host URL from your gateway provider when you register.

    You can use test Host URLs while testing your gateway to verify setup. This ensures a real financial transaction is not mistakenly processed during the testing. Some common live and test Host URLs include:

    • Payflow Pro:
      • Host URL (Test) -- pilot-payflowpro.paypal.com
      • Host URL (Live) -- payflowpro.paypal.com
    • iATS:
      • North America (Test) -- www.iatspayments.com
    • SecurePay:
      • Credit card transactions:
        • Host URL (Test) -- https://test.securepay.com.au/xmlapi/payment
        • Host URL (Live) -- https://api.securepay.com.au/xmlapi/payment
      • Direct debit transactions:
        • Host URL (Test) -- http://test.securepay.com.au/xmlapi/directentry
        • Host URL (Live) -- https://api.securepay.com.au/xmlapi/directentry
    • Moneris:
      • Host URL (Test) -- esqa.moneris.com
      • Host URL (Live) -- www3.moneris.com
    • TNSPay (Test) -- secure.na.tnspayments.com

      • Note: For the most up-to-date live and test Host URL information, contact your gateway provider or refer to your gateway provider documentation.

  8. (Moneris only) In the Vendor field, enter the Store ID you were provided by Moneris.
  9. Enter a UserName (this is the user name supplied by the gateway).
  10. Enter the Password you were given by the gateway provider during the sign-up process. Verify your password.

    11. For Moneris gateways, enter the API token (password) you were provided by Moneris.

  11. Click Save.
  12. Recycle the AsiSchedulerPool:
    1. Open the IIS administrative utility. Go to Start > Administrative Tools > Internet Information Services (IIS) Manager.
    2. In the left navigation panel, go to Sites > Default Web Site. Select to view the Default Web Site Content by Content View.
    3. Select the Asi.Scheduler_ [your instance] application for the instance you installed.
    4. Do one of the following:
      • Right-click and select Manage Application > Browse. An ASP.Net page will open.
      • In the Actions pane, select Browse. An ASP.Net page will open.
    5. Close the browser. The Asi.Scheduler_ [your instance] service is now enabled.

Note: Only two fields are required for the custom gateway: Account Code and Account Description. The remaining fields are available for connection parameters. Your developer can use the data entered to these fields for other purposes, or not at all.

Warning!  

The labels on the fields may not correspond to the data you need to enter. Check with your developer to find out whether these fields require special data for the custom gateway.

If the custom gateway application is not installed or is installed incorrectly on Advanced Accounting Console, the transaction will fail. When a user attempts to save a payment transaction that is dependent on the custom gateway, the authorization process will time out for that transaction. iMIS informs the user that the payment cannot be authorized because the gateway application is not installed correctly.

  • The following message is presented first:
    Custom Gateway not properly installed
The payment type entered for this transaction requires a Custom Gateway for credit card authorizations. The custom gateway is not properly installed on this workstation.
The authorization for this payment transaction will time out.
Please contact your system administrator or the developer of your custom gateway application before processing payments using the specified payment type.

  • Note: An error message identifier, nCCAuthOnly_Custom, at the bottom of this message informs Technical Support that this is not an iMIS issue.

  • After the user clicks OK in the Custom Gateway not properly installed message box, a standard iMIS warning is provided.
    The authorization process timed out. Please contact your system administrator.