NATS4 Epoch

From TMM Wiki
Jump to navigationJump to search
NATS 5
    Biller Instructions
NATS Biller List
2000Charge
2000Charge Gateway
2KCHARGE
A1Payments
Aebill
Aconti
Allopass
AltoBilling
Argus
Authorize.net
Bill1st Gateway
BillAPay Gateway
Billing Revolution
Billing United
Bit-Pay
BoaCompra
Braintree Payments
C2Bill
CardFlex
CCBill
CCBill Flexform
CCBill Web900
CashSend
CashtoCode
Centili
Centrobill
Clearcard
Clearcard IDV
Click and Buy
CoinGate
CoinPayments
CommerceGate
CurePay
DHD
DHDGateway
DIMOCO
EGatePay
ElectraCash
eMerchantPay Gateway
eMPPay.com
Epoch
Escalion
EuroBill
EPGBill.com
Ezic, Inc.
Focal Payments
FXBilling
FXBilling Native
Gateway tokens
Gigadat
Global Access
GlobalCharge
Global DPS
GoCoin
Greta 11 (G11Bill)
GTBill
GTBill GATEWAY
GXBill
ICN Ltd.
Itelebill
Jettis International
Jettis International Gateway
LocalBilling
MobiusPay
MerlinBill
NETbilling
NETbilling Native
NetCash
NetMobile
Netpay International
NoCreditCard
OrbitalPay
Password By Phone
Pay4
Pay900
Payment Network
Paygarden
Paygea
PayPal
Paysite Cash
Payspace
Payspace Gateway
Plug'n Pay
Prime Orange
Probiller
PumaPay
Rocketfuel
RocketGate
RocketGate Native
RSBilling
RSBilling Native
SafeCharge
SafeCharge Native
Secure Billing Worldwide
Secure Billing Worldwide Gateway
Secure Trading
SecurionPay
SegPay
SegPay Gateway
SOFORTdauerauftrag
Sonic Bill
StandardBill
TrustCharge
Telecom
UKash
Vendo Services
Vendo
Verotel Pro
Voxtel
VXSBill
WebBilling
Wispay
WTS
WTSeu
Zombaio
Shopping Cart Sales
Switching From Epoch to Epoch EU
Members Section
Members Management
Adding a Member
View Member Details
Restricted Values
OpenID Connect
Mod Auth OpenIDC
    Adtool
GET /adtool/admin
GET /adtool/adtools
GET /adtool/adtool
GET /adtool/adtool-rules
GET /adtool/adtool-rule
GET /adtool/categories
GET /adtool/field-options
GET /adtool/field-types
GET /adtool/groups
GET /adtool/search
GET /adtool/templates
GET /adtool/types
GET /adtool/type
POST /adtool/adtool
POST /adtool/adtool-rule
POST /adtool/category
POST /adtool/field
POST /adtool/field-option
POST /adtool/group
POST /adtool/import
POST /adtool/type
PATCH /adtool/adtool
PATCH /adtool/adtool-group
PATCH /adtool/adtool-rule
PATCH /adtool/category
PATCH /adtool/field
PATCH /adtool/field-option
PATCH /adtool/group
PATCH /adtool/move
PATCH /adtool/restore-adtool
PATCH /adtool/restore-category
PATCH /adtool/restore-field
PATCH /adtool/restore-field-option
PATCH /adtool/restore-type
PATCH /adtool/type
DELETE /adtool/adtool
DELETE /adtool/adtool-rule
DELETE /adtool/category
DELETE /adtool/field
DELETE /adtool/field-option
DELETE /adtool/group
DELETE /adtool/type
    Affiliate
DELETE /affiliate/account-rep
DELETE /affiliate/account-type
DELETE /affiliate/affiliate
DELETE /affiliate/doc
DELETE /affiliate/group
DELETE /affiliate/permissions
GET /affiliate/account-changes
GET /affiliate/account-types
GET /affiliate/admin-settings
GET /affiliate/campaigns
GET /affiliate/current
GET /affiliate/current-permissions
GET /affiliate/docs
GET /affiliate/doc
GET /affiliate/groups
GET /affiliate/group
GET /affiliate/hits
GET /affiliate/link-styles
GET /affiliate/loginids
GET /affiliate/loginlog
GET /affiliate/manual-payout
GET /affiliate/news-sections
GET /affiliate/notes
GET /affiliate/notices
GET /affiliate/override
GET /affiliate/payout
GET /affiliate/payment-periods
GET /affiliate/payvia-types
GET /affiliate/payvia-type
GET /affiliate/permissions
GET /affiliate/programcampaigns
GET /affiliate/referrer
GET /affiliate/referring-urls
GET /affiliate/reps
GET /affiliate/rest-methods
GET /affiliate/search
GET /affiliate/search-limited
GET /affiliate/settings
GET /affiliate/skins
GET /affiliate/soap-functions
GET /affiliate/status
PATCH /affiliate/adminsettings
PATCH /affiliate/account-change
PATCH /affiliate/account-type
PATCH /affiliate/account-type-permissions
PATCH /affiliate/admin-setting
PATCH /affiliate/affiliate-account-type
PATCH /affiliate/affiliate-group
PATCH /affiliate/allsettings
PATCH /affiliate/account-rep
PATCH /affiliate/avatar
PATCH /affiliate/customs
PATCH /affiliate/defaults
PATCH /affiliate/details
PATCH /affiliate/override
PATCH /affiliate/password
PATCH /affiliate/payment-period
PATCH /affiliate/payvia
PATCH /affiliate/payvia-info
PATCH /affiliate/permissions
PATCH /affiliate/referrer
PATCH /affiliate/reset-api
PATCH /affiliate/reset-rss
PATCH /affiliate/reset-tos
PATCH /affiliate/rest-permissions
PATCH /affiliate/restore
PATCH /affiliate/restore-account-type
PATCH /affiliate/settings
PATCH /affiliate/soap-permissions
PATCH /affiliate/status
POST /affiliate/account-type
POST /affiliate/add
POST /affiliate/doc
POST /affiliate/group
POST /affiliate/invoice
POST /affiliate/manual-sale
POST /affiliate/note
    Biller
GET /biller/available
GET /biller/partner-available
GET /biller/billerdata
GET /biller/cascades
GET /biller/cascades-available
GET /biller/cascade-count
GET /biller/cascade-history
GET /biller/cascade-rules
GET /biller/cascade-rule
GET /biller/cascade-step-count
GET /biller/cascade-steps
GET /biller/cascade-detail
GET /biller/cascade-list
GET /biller/count
GET /biller/detail
GET /biller/fees
GET /biller/partner-fees
GET /biller/last_poll
GET /biller/partner-last-poll
GET /biller/list
GET /biller/partner-detail
GET /biller/partner-list
GET /biller/partner-shortnames
GET /biller/process_types
GET /biller/partner-process-types
GET /biller/shortnames
GET /biller/transaction_types
GET /biller/partner-transaction-types
GET /biller/taxes
POST /biller/add
POST /biller/cascade
POST /biller/cascade-rule
POST /biller/cascade-step
POST /biller/partner
PATCH /biller/cascade
PATCH /biller/cascade-rule
PATCH /biller/cascade-step
PATCH /biller/cascade-steps-reorder
PATCH /biller/fee
PATCH /biller/partner-fee
PATCH /biller/restore
PATCH /biller/restore-cascade
PATCH /biller/restore-partner
PATCH /biller/setting
PATCH /biller/partner-setting
PATCH /biller/tax
DELETE /biller/biller
DELETE /biller/cascade
DELETE /biller/cascade-rule
DELETE /biller/cascade-step
DELETE /biller/fee
DELETE /biller/partner-fee
DELETE /biller/partner
DELETE /biller/tax
    Codes
GET /codes/affiliate-codes
GET /codes/decode
GET /codes/linkcodes
GET /codes/strack
    Config
DELETE /config/setting
GET /config/section
GET /config/sections
PATCH /config/affiliate_default
PATCH /config/section
    Include
DELETE /include/include
DELETE /include/step
GET /include/include
GET /include/includes
GET /include/templates
PATCH /include/include
PATCH /include/restore
PATCH /include/step
POST /include/include
POST /include/step
    Mailing
DELETE /mailing/mailing
DELETE /mailing/mailing-rule
DELETE /mailing/queue
GET /mailing/mailing
GET /mailing/mailings
GET /mailing/mailing-rules
GET /mailing/mailing-rule
GET /mailing/queue
GET /mailing/removelist
PATCH /mailing/mailing
PATCH /mailing/mailing-rule
PATCH /mailing/removelist
PATCH /mailing/removelist-queue
PATCH /mailing/resend-queue
PATCH /mailing/restore-queue
PATCH /mailing/send-mailing
PATCH /mailing/send-test-mailing
POST /mailing/mailing
POST /mailing/mailing-rule
POST /mailing/removelist
    Maintenance
DELETE /maintenance/log
DELETE /maintenance/cache
GET /maintenance/admin-actions
GET /maintenance/log
GET /maintenance/logs
GET /maintenance/nats
GET /maintenance/report
GET /maintenance/report-progress
GET /maintenance/reports
GET /maintenance/server
GET /maintenance/table
GET /maintenance/tables
GET /maintenance/table-clean-count
GET /maintenance/table-clean-progress
PATCH /maintenance/log
PATCH /maintenance/report
PATCH /maintenance/table
    Member
GET /member/available_flags
GET /member/encryptusername
GET /member/authstring
GET /member/details
GET /member/flags
GET /member/loginlog
GET /member/matching
GET /member/notes
GET /member/notices
GET /member/restricted-values
GET /member/search
GET /member/suggestedcanceloffers
GET /member/surfer-actions
PATCH /member/details
PATCH /member/expiration
PATCH /member/expiremanual
PATCH /member/resend-transaction-email
PATCH /member/resend-transaction-postback
PATCH /member/restricted-value
PATCH /member/forget
PATCH /member/lock
PATCH /member/unlock
POST /member/flag
POST /member/login
POST /member/note
POST /member/restricted-value
DELETE /member/flag
DELETE /member/restricted-value
    Message
DELETE /message/message
DELETE /message/permanent
GET /message/count
GET /message/messages
GET /message/view
PATCH /message/read
PATCH /message/unread
PATCH /message/undelete
POST /message/message
    News
DELETE /news/entry
DELETE /news/section
GET /news/entry
GET /news/news
GET /news/sections
PATCH /news/entry
POST /news/entry
POST /news/section
    Notification
DELETE /notification/notification
DELETE /notification/permanent
GET /notification/count
GET /notification/notifications
GET /notification/view
PATCH /notification/read
PATCH /notification/unread
PATCH /notification/undelete
    Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH /option/text
POST /option/rule
    Payment
DELETE /payment/invoice
DELETE /payment/payout-period
DELETE /payment/payvia-field
DELETE /payment/payvia-field-mc
DELETE /payment/payvia-rule
GET /payment/dump-format
GET /payment/dump-formats
GET /payment/invoices
GET /payment/payments
GET /payment/payment-dumps
GET /payment/payment-dump
GET /payment/payment-search
GET /payment/payvia
GET /payment/payvias
GET /payment/payvia-fields
GET /payment/payvia-field-mcs
GET /payment/payout-period
GET /payment/payout-periods
GET /payment/payvia-rules
GET /payment/payvia-rule
GET /payment/payviarule
PATCH /payment/copy-dump-format
PATCH /payment/default-payout-period
PATCH /payment/dump-format
PATCH /payment/duplicate-payvia
PATCH /payment/invoice
PATCH /payment/payment
PATCH /payment/payment-paid
PATCH /payment/payment-store
PATCH /payment/payment-unstore
PATCH /payment/payments
PATCH /payment/payments-unstore
PATCH /payment/payout-period
PATCH /payment/payout-period-affiliates
PATCH /payment/payvia
PATCH /payment/payvia-field
PATCH /payment/payvia-fields-reorder
PATCH /payment/payvia-field-mc
PATCH /payment/payvia-field-mcs-reorder
PATCH /payment/payvia-rule
PATCH /payment/payviarule
PATCH /payment/restore-payout-period
PATCH /payment/restore-payvia-field
PATCH /payment/restore-payvia-field-mc
POST /payment/check-dump
POST /payment/dump-format
POST /payment/import-dump
POST /payment/invoice
POST /payment/payout-period
POST /payment/payvia
POST /payment/payvia-field
POST /payment/payvia-field-mc
POST /payment/payvia-rule
    Program
DELETE /program/program
DELETE /program/payout-change
DELETE /program/payout-change-tier
GET /program/additional-payout-change-targets
GET /program/affiliate-available
GET /program/detail
GET /program/list
GET /program/options
GET /program/payout-changes
GET /program/redirect-available
GET /program/sites
GET /program/tours
GET /program/types
PATCH /program/default_payout
PATCH /program/details
PATCH /program/disable_affiliate
PATCH /program/disable_tour
PATCH /program/enable_affiliate
PATCH /program/enable_site
PATCH /program/enable_tour
PATCH /program/move-payout-change
PATCH /program/payout-change
PATCH /program/payout-change-tier
POST /program/new
POST /program/payout-change
POST /program/payout-change-tier
    Report
GET /report/affiliate-ratios
GET /report/hits
GET /report/hit-totals
GET /report/profitloss
GET /report/profit-loss
GET /report/fields
GET /report/focus
GET /report/focuses
GET /report/groups
GET /report/perspective
GET /report/perspectives
GET /report/report
GET /report/subscription
GET /report/surfer
GET /report/surferaction
GET /report/transactionpayouts
GET /report/transactions
GET /report/transaction
GET /report/report-widget
GET /report/widgets
GET /report/widget
GET /report/widget-info
GET /report/views
POST /report/focus
POST /report/group
POST /report/perspective
PATCH /report/focus
PATCH /report/focus-enabled
PATCH /report/focus-default
PATCH /report/focuses-reorder
PATCH /report/perspective
PATCH /report/perspective-group
PATCH /report/report-widget
PATCH /report/widget
DELETE /report/focus
    Reward
DELETE /reward/category
DELETE /reward/purchase
DELETE /reward/point
DELETE /reward/reward
GET /reward/categories
GET /reward/points
GET /reward/purchases
GET /reward/rewards
PATCH /reward/move-point
PATCH /reward/point
PATCH /reward/reward
PATCH /reward/ship-purchase
PATCH /reward/unship-purchase
POST /reward/category
POST /reward/point
POST /reward/reward
    Service
GET /service/check-functions
GET /service/condition
GET /service/countries
GET /service/country
GET /service/datetime
GET /service/languages
GET /service/periods
GET /service/ping
GET /service/project
GET /service/rule-condition-data
GET /service/rule-info
GET /service/stats-breakdowns
GET /service/timezone
GET /service/timestamp
POST /service/sendemail
    Site
GET /site/base-templates
GET /site/billers
GET /site/cookies
GET /site/coupon
GET /site/coupons
GET /site/coupon-revisions
GET /site/email-settings
GET /site/groups
GET /site/option
GET /site/options
GET /site/options-available
GET /site/option-fields
GET /site/option-rules
GET /site/option-rule
GET /site/option-type
GET /site/option-types
GET /site/programs
GET /site/redirect
GET /site/redirects
GET /site/redirect-rules
GET /site/redirect-rule
GET /site/site-list
GET /site/site
GET /site/site-notices
GET /site/site-partner
GET /site/site-partners
GET /site/site-type
GET /site/sites
GET /site/template
GET /site/templates
GET /site/template-sections
GET /site/template-sites
GET /site/tour
GET /site/tours
GET /site/tour-emails
GET /site/tour-notices
POST /site/coupon
POST /site/group
POST /site/option
POST /site/option-rule
POST /site/redirect
POST /site/redirect-rule
POST /site/site-partner
POST /site/site-tour
POST /site/copy-template
POST /site/tour
PATCH /site/cookie
PATCH /site/coupon
PATCH /site/duplicate-option
PATCH /site/email-settings
PATCH /site/group
PATCH /site/move
PATCH /site/option
PATCH /site/option-rule
PATCH /site/redirect
PATCH /site/redirect-rule
PATCH /site/reset-coupon
PATCH /site/restore-group
PATCH /site/restore-option
PATCH /site/restore-redirect
PATCH /site/restore-site
PATCH /site/restore-site-partner
PATCH /site/restore-tour
PATCH /site/site
PATCH /site/site-partner
PATCH /site/template
PATCH /site/tour
DELETE /site/cookie
DELETE /site/group
DELETE /site/option
DELETE /site/option-rule
DELETE /site/site
DELETE /site/site-partner
DELETE /site/redirect
DELETE /site/redirect-rule
DELETE /site/template
DELETE /site/tour
DELETE /site/tour-field
    Skin
DELETE /skin/skin
DELETE /skin/template
GET /skin/colors
GET /skin/export
GET /skin/skins
GET /skin/sections
GET /skin/templates
GET /skin/template
PATCH /skin/colors
PATCH /skin/flush
PATCH /skin/skin
PATCH /skin/template
POST /skin/copy-template
POST /skin/import
POST /skin/skin
POST /skin/template
NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers

Set up on Epoch Website

Before you can begin configuring Epoch as a biller in NATS4, you must first register a merchant account with them. This can be done through their website at https://www.epoch.com/. Make sure to record your Company Account Code, Master Code, and Salt String while registering.

Setup your site on Epoch's website or send them an e-email using their support form. In either case, you must give Epoch the following information:

  • Site Name: Your site name.
  • Pricing Options: List all pricing options you want Epoch to setup. They will send you product codes for each one.
  • Postback URL: http://linkdomain/signup/process_epoch.php
    • please note to use 'https' if using SSL on your linkdomains

Replace linkdomain in the above example with your linkdomain. Record your Epoch Product Code for each site.

If you use a .htaccess password file and need Epoch to add and remove logins to it, you also need to give them the following information:

  • Password File Path: The path to your password file on the server.
  • Password Script URL: The URL of the epoch password script located on the same server as the site.

If you use MySql Auth for access verification, you also need to give them the following information. (Please use this method if possible.)

  • Password File Path: Tell them to set this to your NATS site ID number
  • Password Script URL: http://linkdomain/signup/passwd_epoch.php
  • Please ask Epoch to enable x_* variables for CHECK command. (This needs to be done in order for check username to work).

Replace linkdomain with your linkdomain.

Set up DataPlus

You MUST setup DataPlus. If you don't, Epoch can't tell NATS about rebills, credits, or chargebacks.

Database Permissions

There are two tables in the NATS database for Epoch's DataPlus: EpochTransStats and MemberCancelStats. You need to create a user in MySQL coming from Epoch's IP range and grant that user insert and select privileges on the above two tables. Do that by logining into MySQL with root privileges and executing the following commands:

grant insert, select on <database>.EpochTransStats to <username>@'<IP Address Range>' identified by '<password>';
grant insert, select on <database>.MemberCancelStats to <username>@'<IP Address Range>' identified by '<password>';
flush privileges;

Replace <database> with the name of your NATS database. Replace <username> is the username for the Epoch user you are creating. Replace <password> with the password for the Epoch user you are creating. Ask Epoch for their IP address range and replace <IP Address Range> with that range.

Email the username and password you created along with the NATS database name and IP address to Epoch, and ask them to turn on DataPlus on both tables.

NATS EpochTransStats table has the following optional database columns. If Epoch is not already writing data for these columns, please contact Epoch and request that Epoch populate these fields as part of the Data Plus integration:

4.1.2.1

  • ets_initial_member

4.1.2.2

  • ets_return_type

4.1.7.1

  • ets_test

4.1.8.1

  • ets_prepaid

4.1.9.1

  • ets_subscription_passthrough1
  • ets_subscription_passthrough2
  • ets_subscription_passthrough3
  • ets_subscription_passthrough4
  • ets_subscription_passthrough5

Setting Up Epoch in NATS

Billers Admin

To begin setting up Epoch as a biller in NATS, go to the Billers Admin. Scroll down to the "Biller" drop-down menu, select "Paycom.net (Epoch Systems)," and click "Add."

Note: If you don't see Paycom.net/Epoch as a biller in NATS4, put in a support ticket, as you may need an updated version of NATS.

When prompted, fill in the Company Code that were provided to you by Epoch under the "Account Info" section. If you were not provided with this information, please contact your biller to receive it.

Sites Admin

Next, go to the Sites Admin, create or edit a tour, and scroll down to the "Biller Details" section. Edit any of the optional "EPOCH" settings available here -- these affect how certain elements on the Epoch join form appear to your members. The settings on this page include:

  • No UserPass - Disables Epoch password management @CHECK
  • EmailPlus Template - The template to display for email plus
  • Retry Count - The Number of times a surfer can retry the Epoch join form before denied.
  • Text Color - The HTML Color for main text on Epoch join form. This should be in hex format.
  • Background Color - The HTML Color for main background on Epoch join form. This should be in hex format.
  • Link Color - The HTML Color for links on Epoch join form. This should be in hex format.
  • Error Text Color - The HTML color for links on the Epoch join form. This should be in hex format.
  • EZClick Background Color - The HTML Color for main background of EZClick Table if present. This should be in hex format.
  • EZClick Text Color - The HTML Color for main text of EZClick Table if present. This should be in hex format.
  • EZClick Title Background Color - The HTML Color for header background of the EZClick Table (if present). This should be in hex format.
  • EZClick Title Text Color - The HTML Color for header text of the EZClick Table (if present). This should be in hex format.
  • Top Images - Used when a client would like to personalize their join forms a bit more. These cannot contain images of models or any other copyrighted material. They're usually just the site logo.
  • EmailPlus Template
  • No UserPass
  • Enable Test Mode - Enable Epoch Test Mode
  • Test Mode Allow IPS - Restrict Epoch Test Mode to specific IP address(es)
  • Display All options - Display all NATS configured options on Epoch join page


Once you have done this, scroll down to the section labeled "join Options for this Tour" and click the "Edit Option Details for this tour" icon that corresponds to the join option you wish to use, or create a new join option. In the "Biller Codes" section on the next page, locate the EPOCH Product Code and EPOCH List (optional) fields and enter your Product Code and List (optional).

Additionally you may wish to edit/add any additional rules to allow this option to show on your join page. You can do so with the purple arrows next to the Option row on the main Billers page. This is similar to the other rules pages in NATS.

Cross Sales

Epoch also supports Cross Sale transactions through NATS. In order to process cross sale transactions, however, you will first have to set them up with Epoch. Please contact Epoch for assistance with this.

To set up cross sales in NATS, go to the Upsells Admin and click Incoming or Outgoing cross sales from the navigation tabs at the top of the page (depending on whether you are receiving or sending the cross sale).

If you are sending a cross sale to another site, go to the "Outgoing Cross Sales" page. Add "EPOCH" from the "Biller" drop-down menu, and then click Add New Option. On the next page, you will be prompted to fill in the Title, Description, and Disclaimer for your cross sell option.

You will then need to fill out the Biller Info for your cross sale, which should have been provided to you by Epoch. Fill in your Offer Code, Offer Ref 1, and Offer Ref 2 here, choose whether you want the option to be "Tangible," and save your changes.

If you are receiving the cross sale, go to the "Incoming Cross Sales" page. Add "EPOCH" from the "Biller" drop-down menu and click Add New Option. When prompted, choose the site and program you want to associate with the cross sale.

Under "Details," fill in the title of your cross sale option, the initial membership fee and length, and the recurring fee and length. Finally, fill in your Offer Code and Product Code that you received from Epoch/Paycom in the "Biller Info" section, and click Save Changes.

If you would want to setup Cross Sale like a bundle Cross Sale options, you will enable "Epoch shopping cart api" checkbox, and you will required to enter the "Product Code for Offer Ref 1" or "Product Code for Offer Ref 2" in order to used this feature. (This feature does not work with Epoch Password Script on username check case, you must request Epoch to disable password script feature in order to used this feature).

EZClick

Epoch's EZClick lets you add special offers to your epoch join forms which can make you extra money. NATS lets you to put EZClicks on your join forms and also lets you let others use EZClicks on their join forms to cross-sell one of your products.

To add an EZClick to one of your join forms, you must click the cross sells icon in the option's code row the EZClick should appear on. There you can simply add EZClicks you have setup previously.

To setup new EZClicks, use the same icon located on the very bottom of each page (Cross Sell Admin) with all the other Admin icons. There you can add and edit Cross Sells for all supported billers.

To offer one or more of your products to others as EZClicks, contact support@epoch.com and tell them to setup a new EZClick. Give them the product code or codes (you may setup an EZClick with 2 offers) and tell them to pre-check them or not.

Now you have to setup Incoming Cross Sells via the Cross Sell Admin. This is explained on the Cross Sell Admin page directly.

Package Plus

The Epoch Flexgrade functionality has been added to NATS, after version 4.1.4.1. Within NATS, this is called Package Plus integration. This feature allows you to offer your members incentives to upgrade their memberships to a higher tier in your Members Area. For more information on Package Plus, visit the Package Plus wiki.

NATS uses the option level field "Package TI Code" (Epoch: ti_code) that correlates to the specific package on Epoch's side.

The "Package Amount" (Epoch: upgrade_charge) field is available depending on your setup (refer to Epoch)

With the packageexpires integration, only available for Epoch, you can reactivate expired members and change the price point. However, you need to configure the MemberPlus join option configurations:

Allow Memberplus Process on Package Upgrade?  : Yes
Memberplus PI Code on Package Upgrade : {Package PI code}*
  • The package PI code may be the same as the option's PI code. Please consult with Epoch to ensure that the correct value is configured.

UpgradePlus

Epoch UpgradePlus lets you shorten a Member's Trial by offering them incentives to upgrade in your Members Area. Most users do this by offering them two separate Members Areas. One for members that are only in their Trial Phase giving them only limited amount of content and a separate one which gives access to the full content for people that paid for the full month.

There are two ways to use this system:

  • MySQL Auth: If you use MySQL Auth in your Server to authenticate members using the NATS members table you can add an additional check to see if a member is in their trial or full membership and give them the right access respectively.
  • Your own System: You could also use the Site's Upgrade Post URL you can setup via the NATS Site Admin to receive upgrade notifications to your own scripts. Your scripts would then mark the member in a way you can figure out what to give them access to. We can not help you with setting up such a script though.

To use UpgradePlus on your site, you must follow the instructions located in the Epoch UpgradePlus documentation except for the following:

  • UpgradePlus URLs: The buttons or links you use to open Epoch UpgradePlus should not use the URL mentioned, but instead you should use:
http://<linkdomain>/signup/upgradeplus.php?site=<siteid>&username=<username>
  • Template returnurl: The returnurl variable you need to add to the accept offer button as mentioned in the documentation needs to be set to the following URL:
http://<linkdomain>/signup/returnurl_epoch_upgradeplus.php

Replace <linkdomain> with the site's linkdomain. Replace <siteid> with the site's number, replace <username> with the upgrading user's username. (To get the Username with PHP, use <?=$_SERVER['REMOTE_USER']?>)

TokenPlus

Epoch now offers support for the Token Plus feature in NATS4. This feature allows members of your Token Sites to purchase additional tokens for their account, without requiring them to re-input their payment information to do so. This allows your members to easily buy additional tokens without having to go through any extra steps.

Before you can begin configuring Epoch to work with the Token Plus feature, you must first enable it for the sites you want to offer it on in the Sites Admin. Go to the Sites Admin, locate the Token Site that you want to enable this feature on, and click the "Set Join Options" action icon. Edit the join option that you want to enable Token Plus for, then check the "Token Rebuy Allowed" setting here.

For more information on this process, please see our Token Plus wiki article.

Note: In order to use the Token Plus feature with Epoch, you must have camcharge transactions enabled. If this feature is not currently on, please contact Epoch to have them enable it.
Note: You need to contact Epoch support and have them setup x_token_rebuy to be posted in dataplus in token_rebuy field.
Note: You need to contact Epoch support and ask them for the Master code and Salt String. Please update these fields within the billers admin.

Upsells

As of version 4.0.75.1, Nats supports upsells with Epoch through the MemberPlus system. The upsell setup is described here: http://wiki.toomuchmedia.com/index.php/Upsells_Admin. Epoch specific data is listed below:

The following fields are required for an outgoing upsell:

  • Product Code - the Epoch pi code that you want to upsell
  • Partner Company Code - the company code of the receiving end of the upsell. This will be the same as your company code if you are sending and receiving the cross sale under the same Epoch account.
  • Ref Code - the Nats ref code that is required to track the upsell.

The following fields are required for an incoming upsell:

  • Product Code - the product code that is assigned to this upsell.


UpsellPlus

Epoch supports the passing custom variables via adding the member_extra field to the UpsellPlus request. Ex. (&member_extra[<upsellid>][<customvariable>]=<customvalue>). This will allow you to send a custom variable to be stored on Epoch's end. This variable will not get recorded in NATS via the postback from Epoch.

If you would like to record additional information on the Upsell member record we suggest to use the subscription_passthrough 1-5 variables. An example of what would be added to your UpsellPlus Url:

&member_extra[0][subscription_passthrough1]=<customvalue>

Processing with PayPal via EPOCH

To process sales via the Epoch PayPal integration, you will want to create a PayPal cascade. Then, you need to add an Epoch biller cascade step by selecting Epoch from the Biller dropdown. Once selected, click the Add button. Once you have saved the first cascade step, NATS will display the cascade step in edit mode. From the processing Types dropdown, select PayPal. Then, click the Save button. Once the step is completely configured, you can edit the cascade description, which is used to display the payment option on your join forms. Finally, you will need to configure rule(s) for displaying this cascade to surfers.

Optional Epoch Configuration Settings

EPOCH EXPIRE PAD

NATS gives you the ability to set an expire padding specific to EPOCH. This can be setup in the Configuration Admin -> Biller tab.

Upgrading from No Cost Registration

If you are allowing No Cost Registration (NCR) members to upgrade to full memberships with Epoch there is a configuration you will need to change. When setting up with Epoch, you must disable the "Check" username post with Epoch to prevent this check from occurring or the surfer will not be able to submit the Epoch join form.

EPOCH ALLOW ALL CO CODE

This setting will allow NATS to record all transactions from unknown CO_Codes via the Epoch Poll script, if you wish to enable this config setting, please make sure the setting "ALLOW_CREATE_NEW_MEMBER_EPOCH" is DISABLED, if not, all transactions outside of NATS will generate new member records instead of updating the existing never-joined member record.