Difference between revisions of "NATS4 SegPay"

From TMM Wiki
Jump to navigationJump to search
 
(43 intermediate revisions by 12 users not shown)
Line 1: Line 1:
 
{{Not Finished}} [[Category:N4CHECK]]
 
{{Not Finished}} [[Category:N4CHECK]]
{{NATS4 Manual
+
{{NATS5 Manual
| show_billers_section = true
+
|show_billers_section = true
 
}}
 
}}
 +
{{NATS4 Manual}}
  
 
Note: [http://segpayeu.com/documents/2.0/SegpayNatsSetupInfo.pdf Segpay's instructions] may be more up to date.
 
Note: [http://segpayeu.com/documents/2.0/SegpayNatsSetupInfo.pdf Segpay's instructions] may be more up to date.
Line 20: Line 21:
 
Set this as the 2nd Trans Post URL in each one of your current Postback Notification Profiles:
 
Set this as the 2nd Trans Post URL in each one of your current Postback Notification Profiles:
  
* 2nd Trans Post URL: linkdomain/signup/process_tmmsegpay.php?action=<action>&stage=<stage>&approved=<approved>&name=<billname>&email=<billemail>&country=<billcntry>&state=<billstate>&city=<billcity>&address=<billaddr>&transtype=<trantype>&purchaseid=<purchaseid>&transid=<tranid>&price=<price>&username=<extra username>&password=<extra password>&currencycode=<currencycode>&eticketid=<eticketid>&memberid=<extra foreignid>&session=<extra natssess>&merchantpartnerid=<extra merchantpartnerid>&xsellnum=<xsellnum>
+
* 2nd Trans Post URL: linkdomain/signup/process_segpay.php?action=<action>&stage=<stage>&approved=<approved>&name=<billname>&email=<billemail>&country=<billcntry>&state=<billstate>&city=<billcity>&address=<billaddr>&transtype=<trantype>&purchaseid=<purchaseid>&transid=<tranid>&price=<price>&username=<extra username>&password=<extra password>&currencycode=<currencycode>&eticketid=<eticketid>&memberid=<extra foreignid>&session=<extra natssess>&merchantpartnerid=<extra merchantpartnerid>&xsellnum=<xsellnum>
  
 
* 2nd Trans Post Message (You must include the * before and after the word success): *success*  
 
* 2nd Trans Post Message (You must include the * before and after the word success): *success*  
Line 29: Line 30:
 
package information section of the SegPay site, setup your join options;
 
package information section of the SegPay site, setup your join options;
 
for each option, record the SegPay Order I.D.
 
for each option, record the SegPay Order I.D.
 +
 +
'''Note:''' When testing signups and cascading with Segpay, if you get to their auth/decline page and it does not redirect back to NATS automatically, please contact Segpay.  They may need to enable a package which allows for automatic redirection on auth/decline.
 +
<!-- I was informed by Christina Marquez at segpay that this manual package enabling shouldn't be needed for much longer, but wanted to add this help text in the mean time -->
  
 
== NATS Member Management ==
 
== NATS Member Management ==
Line 43: Line 47:
  
 
* Inquiry URL:
 
* Inquiry URL:
linkdomain/signup/process_tmmsegpay.php?action=<action>&username=<extra username>&memberid=<extra foreignid>
+
linkdomain/signup/process_segpay.php?action=<action>&username=<extra username>&memberid=<extra foreignid>
 
* Inquiry Result Good: *success* (You must include the * before and after the word success)
 
* Inquiry Result Good: *success* (You must include the * before and after the word success)
 
* Access Enable URL: THIS FIELD IS NOT USED.
 
* Access Enable URL: THIS FIELD IS NOT USED.
 
* Access Enable MSG: THIS FIELD IS NOT USED.
 
* Access Enable MSG: THIS FIELD IS NOT USED.
* Access Disable URL: linkdomain/signup/process_tmmsegpay.php?action=<action>&username=<extra username>&password=<extra password>&purchaseid=<purchaseid>
+
* Access Disable URL: linkdomain/signup/process_segpay.php?action=<action>&username=<extra username>&password=<extra password>&purchaseid=<purchaseid>
 
* Access Disable MSG: *success* (You must include the * before and after the word success)
 
* Access Disable MSG: *success* (You must include the * before and after the word success)
 
* Cancel URL: THIS FIELD IS NOT USED.
 
* Cancel URL: THIS FIELD IS NOT USED.
 
* Cancel Match: THIS FIELD IS NOT USED.
 
* Cancel Match: THIS FIELD IS NOT USED.
* 2nd Trans Post URL: linkdomain/signup/process_tmmsegpay.php?action=<action>&stage=<stage>&approved=<approved>& name=<billname>&email=<billemail>&country=<billcntry>&state=<billstate>&city=<billcity>&address =<billaddr>&transtype=<trantype>&purchaseid=<purchaseid>&transid=<tranid>&price=<price>&user name=<extra username>&password=<extra password>&currencycode=<currencycode>&eticketid=<eticketid>&memberid=<extra foreignid>&session=<extra natssess>&merchantpartnerid=<extra merchantpartnerid>&xsellnum=<xsellnum>
+
* 2nd Trans Post URL: linkdomain/signup/process_segpay.php?action=<action>&stage=<stage>&approved=<approved>& name=<billname>&email=<billemail>&country=<billcntry>&state=<billstate>&city=<billcity>&address =<billaddr>&transtype=<trantype>&purchaseid=<purchaseid>&transid=<tranid>&price=<price>&user name=<extra username>&password=<extra password>&currencycode=<currencycode>&eticketid=<eticketid>&memberid=<extra foreignid>&session=<extra natssess>&merchantpartnerid=<extra merchantpartnerid>&xsellnum=<xsellnum>
 
* 2nd Trans Post Message: (You must include the * before and after the word success): *success*  
 
* 2nd Trans Post Message: (You must include the * before and after the word success): *success*  
 
Under the EMAIL TEMPLATES section, you must enter the following
 
information so that receipts to go out.
 
 
* Sign-Up Template: email.signup.xml
 
* Rebill Template: default
 
* Cancel Template: email.cancel.xml
 
* Expiration Template: default
 
  
 
After you fill in all the appropriate fields, click on the UPDATE
 
After you fill in all the appropriate fields, click on the UPDATE
Line 82: Line 78:
 
=== Sites Admin ===
 
=== Sites Admin ===
  
Next, go to the [[NATS4 Sites Admin|Sites Admin]], create or edit a [[Ct#Tour|tour]], and scroll down to the "Biller Details" section. Enter the E-Ticket ID that you set up on SegPay's website for each [[Pay Via Types|Pay Via Type]] you wish to use.
+
Next, go to the [[NATS4 Sites Admin|Sites Admin]], create or edit a [[Ct#Tour|tour]], and scroll down to the "Biller Details" section. Enter the E-Ticket ID (Segpay may call this a PackageID) and Order ID (Segpay may call this a PricePointID) that you set up on SegPay's website for each [[Pay Via Types|Pay Via Type]] you wish to use.
  
'''Note:''' As of version '''4.0.77.1''', [[NATS]] now supports Direct Debit (elv) as an processing type for [[Ct#Member|member]] transactions through SegPay. If you want to add Direct Debit (elv) compatibility to SegPay, please [https://clients.toomuchmedia.com put in support ticket] to be upgraded to the latest version of [[NATS]].
+
'''Note:''' As of version '''4.0.77.1''', [[NATS]] now supports Direct Debit (elv) as an processing type for [[Ct#Member|member]] transactions through SegPay. If you want to add Direct Debit (elv) compatibility to SegPay, please [https://clients.toomuchmedia.com put in support ticket] to be upgraded to the latest version of [[NATS]].  For information on setting this up once you have it in your nats, see the [[NATS4_SegPay#Setting_up_Segpay_Direct_Debit|Direct Debit]] section below.
  
 
You can also use the optional Custom Auth Text and Custom Decline Text fields to determine what you wish to display to the [[Ct#Surfer|surfer]] on the SegPay approval and denial pages. Save your changes once you have filled in the required fields here.
 
You can also use the optional Custom Auth Text and Custom Decline Text fields to determine what you wish to display to the [[Ct#Surfer|surfer]] on the SegPay approval and denial pages. Save your changes once you have filled in the required fields here.
Line 90: Line 86:
 
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 [[Ct#Join Option|join option]] you wish to add Segpay compatibility to. In the "Biller Codes" section on the next page, locate the "SEGPAY Order ID" field, and enter the Order ID you received from SegPay for the [[Ct#Join Option|join option]] you are configuring. You can also put in a E-Ticket number in the "SEGPAY E-Ticket Override" fields (CC, Check, and elv), which replaces the E-Ticket that you specified in the "Biller Details" section.
 
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 [[Ct#Join Option|join option]] you wish to add Segpay compatibility to. In the "Biller Codes" section on the next page, locate the "SEGPAY Order ID" field, and enter the Order ID you received from SegPay for the [[Ct#Join Option|join option]] you are configuring. You can also put in a E-Ticket number in the "SEGPAY E-Ticket Override" fields (CC, Check, and elv), which replaces the E-Ticket that you specified in the "Biller Details" section.
  
While you can use the Override options provided by SegPay to offer multiple payment types for the same [[Ct#Join Option|join option]], we recommend that you set up a separate [[Ct#Join Option|join option]] for each payment method you wish to offer through SegPay for your [[Ct#Member|members]].
+
While you can use the Override options provided by SegPay to offer multiple payment types for the same [[Ct#Join Option|join option]], you '''must''' set up a separate [[Ct#Join Option|join option]] for each payment method you wish to offer through SegPay for your [[Ct#Member|members]].  See the [[NATS4_SegPay#Setting_up_Segpay_Direct_Debit|Direct Debit section]] below.
 +
 
 +
'''Note:''' As of version '''4.1.5.1''', when editing a price point in [[NATS]], there is an optional biller detail called "Dynamic Pricing". When this is checked, the biller will use the initial amount set in NATS for the sale, overriding what may be set in the biller for that price point. When this is not checked, SegPay will instead use the initial amount defined in the biller.
 +
 
 +
Note: As of version '''4.1.22.1''' or above, Segpay now support Dynamic Recurring feature, when editing the tour setting, there is an optional biller detail called "Dynamic Recurring Billing E-Ticket ID" and option setting "Dynamic Recurring Billing" checkbox under each join option. You will required to setup a Dynamic Recurring Billing E-Ticket ID at Segpay side and used the Dynamic Recurring Billing feature with any join options in NATS.
  
 
Additionally, you may wish to edit/add any additional [[NATS4 Rules|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 (similar to the several other areas across NATS).
 
Additionally, you may wish to edit/add any additional [[NATS4 Rules|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 (similar to the several other areas across NATS).
  
'''Note: If you input an incorrect E-Ticket ID and Order ID combination in the [[NATS4 Sites Admin|Sites Admin]], your [[Ct#Cascade|cascade]] will not function. Please make sure that you test each E-Ticket ID and Order ID combination you have set up to make sure that they work.'''
+
'''Note: If you input an incorrect E-Ticket ID and Order ID combination in the [[NATS4 Sites Admin|Sites Admin]], your [[Ct#Cascade|cascade]] will stop at that step with an error message. Please make sure that you test each E-Ticket ID and Order ID combination you have set up to make sure that they work.'''
 +
 
 +
As of version '''5.0.4.1''', Segpay now supports paypal as a process type. There  is no specific eticketid for paypal, it will use the eticketid under 'CC eticketid' instead
 +
 
 +
===Setting up Segpay Direct Debit===
 +
 
 +
To set up Segpay with Direct Debit, you '''MUST''' set up separate join option for both currency types: One for '''GBP''', and one for '''EUR'''.  This will allow surfers to use both currencies and switch between the currency types on the biller form.  These join options will have a separate E-ticket ID '''(provided by Segpay)''' for each currency type.  You will then need to add a country rule to the join options for the correct country(ex Germany for EUR). 
 +
 
 +
Ex codes for all payment types:<br>
 +
Credit Card: 150350:13116<br>
 +
Checks: 150591:13116<br>
 +
Direct Debit EUR: 150607:13194 <br>
 +
Direct Debit GBP: 150607:13195<br>
  
=== Cross Sells ===
+
=== Cross Sells and Upsells===
  
 
You need to add the following to your Trans Post URL in order to process cross sells:
 
You need to add the following to your Trans Post URL in order to process cross sells:
&eticketid=<eticketid>&xref=<xref>. Segpay will then provide you
+
&eticketid=<eticketid>&xref1=<extra xref1>. Segpay will then provide you
 
with an E-Ticket ID for each cross sell. The E-Ticket I.Ds. are formatted
 
with an E-Ticket ID for each cross sell. The E-Ticket I.Ds. are formatted
 
as follows: site:product.
 
as follows: site:product.
 +
 +
 +
You need to add the following to your Trans Post URL in order to process upsells:
 +
&eticketid=<eticketid>&upsell=<extra upsell>. Segpay will then provide you
 +
with an E-Ticket ID for each upsell. The E-Ticket I.Ds. are formatted
 +
as follows: site:product.
 +
  
 
To set up [[Ct#Cross Sell|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).
 
To set up [[Ct#Cross Sell|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).
Line 113: Line 132:
 
Under "Details," fill in the title of your [[Ct#Cross Sell|cross sale]] option, the initial fee and length, and the recurring membership fee and length. Finally, fill in the CC E-Ticket ID, Check E-Ticket ID, and Order ID that were provided to you by SegPay. In this section, your "E-Ticket ID" corresponds to your [[Ct#Site|site]], and your "Order ID" corresponds to your [[Ct#Join Option|join option]]. Once you have filled out the available fields, you will be able to activate your [[Ct#Cross Sell|cross sell]] options.
 
Under "Details," fill in the title of your [[Ct#Cross Sell|cross sale]] option, the initial fee and length, and the recurring membership fee and length. Finally, fill in the CC E-Ticket ID, Check E-Ticket ID, and Order ID that were provided to you by SegPay. In this section, your "E-Ticket ID" corresponds to your [[Ct#Site|site]], and your "Order ID" corresponds to your [[Ct#Join Option|join option]]. Once you have filled out the available fields, you will be able to activate your [[Ct#Cross Sell|cross sell]] options.
  
By default, your [[Ct#Cross Sell|cross sells]] will be credited to the account you used to get the code entered under Ref Code. If you would like to credit cross sells to the reseller that sent the original signup, you can enable the following configuration variable: $config['XSELL_SEGPAY_RESELLER'].
+
For upsell redirect, if you wish the redirect to display upsell member record instead of initial sale member record, you must request Segpay to return "PurcahseID" back to NATS during the returnurl redirect.
 +
 
 +
=== TokenPlus ===
 +
 
 +
SegPay now offers support for the [[Token Plus]] feature in [[NATS4]]. This feature allows [[Ct#Member|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 [[Ct#Member|members]] to easily buy additional tokens without having to go through any extra steps.
 +
 
 +
Before you can begin configuring SegPay to work with the [[Token Plus]] feature, you must first enable it for the [[Ct#Site|sites]] you want to offer it on in the [[NATS4 Sites Admin|Sites Admin]]. Go to the [[NATS4 Sites Admin|Sites Admin]], locate the [[Token Sites|Token Site]] that you want to enable this feature on, and click the "Set Join Options" action icon. Edit the [[Ct#Join Option|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 Credit Card transactions SegPay, you must have One Click approved and enabled for each price point. If this feature is not currently on, please contact SegPay to have them enable it.<br>
 +
'''Note:''' One Click transactions are only available for Credit Card sales.
 +
 
 +
=== PackagePlus ===
 +
 
 +
SegPay now support Packageplus feature, it will allow you to change the amount that a consumer will be charged on his/her next bill date. However, SegPay does not currently support switching to an option with a different rebill cycle.
 +
 
 +
<font color="red"><b>In 5.0.5.1 and above: </b></font>
 +
SegPay Package Plus now supports package upgrades, based on the recurring amount. Segpay now allows for a different recurring period between the current and the new price point.
 +
This change also allows Segpay to charge the member during the package upgrade process
 +
 
 +
=== SignupPlus ===
 +
 
 +
As of NATS version 5.0.2.7, Segpay supports [[Signup Plus]]
 +
 
 +
=== UpgradePlus ===
 +
 
 +
UpgradePlus lets you shorten a [[Ct#Member|Member]]'s [[Ct#Trial Sign-up|Trial]] by offering them incentives to upgrade to a full member. 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 members that paid for the full month.
 +
 
 +
To use upgrade plus, the price points in NATS Segpay need to be set up to allow "instant conversion". To do this, you must contact Segpay. Without the allowance of "instant conversion", members connected to that price point will not be allowed to upgrade. After "instant conversion" is allowed, Segpay will send a TransGUID within their "initial" post to process_segpay. Then, members connected to that price point will have an "upgradeid" connected to their information, allowing the upgrade to take place.
  
 
== Notes ==
 
== Notes ==
Line 124: Line 174:
  
 
Change the '6' into an '8' and it will work fine.
 
Change the '6' into an '8' and it will work fine.
 +
 +
[[Category:NATS4 Biller Instructions]]

Latest revision as of 10:24, 11 April 2024

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

Note: Segpay's instructions may be more up to date.

Setup your NATS program site with SegPay. You must update your Postback Notification Profiles or users won't be added or deleted correctly and your transactions won't be updated. Previously you didn't need to enter a user I.D. or access key, but now you must enter them both.

Set up on SegPay's Website

Segpay Member Management

If you only use NATS for cascading and affiliate tracking and you use Segpay for your password management, you only need to enter information in the 2nd Trans Post URL field and MSG for each profile.

Set this as the 2nd Trans Post URL in each one of your current Postback Notification Profiles:

  • 2nd Trans Post URL: linkdomain/signup/process_segpay.php?action=<action>&stage=<stage>&approved=<approved>&name=<billname>&email=<billemail>&country=<billcntry>&state=<billstate>&city=<billcity>&address=<billaddr>&transtype=<trantype>&purchaseid=<purchaseid>&transid=<tranid>&price=<price>&username=<extra username>&password=<extra password>&currencycode=<currencycode>&eticketid=<eticketid>&memberid=<extra foreignid>&session=<extra natssess>&merchantpartnerid=<extra merchantpartnerid>&xsellnum=<xsellnum>
  • 2nd Trans Post Message (You must include the * before and after the word success): *success*

You need to record the following information when you setup SegPay join options. On the Merchant Setup page, under Packages, choose a package and record the Package I.D.; the I.D. number ends with a colon. In the package information section of the SegPay site, setup your join options; for each option, record the SegPay Order I.D.

Note: When testing signups and cascading with Segpay, if you get to their auth/decline page and it does not redirect back to NATS automatically, please contact Segpay. They may need to enable a package which allows for automatic redirection on auth/decline.

NATS Member Management

The section is what you need to enter if you are using NATS for everything including your member management. You should only need to create one profile, "NATS", for all your packages at Segpay since all the data is going to the same place.

To create this, go to https://my.segpay.com. Go to MERCHANT SETUP->POST BACK. Click on the button to create NEW POSTBACK CONFIG. For DESCRIPTION, this is where you would enter the name NATS. Fill in the following in bold for each field, replacing linkdomain with that of the site:

  • Inquiry URL:

linkdomain/signup/process_segpay.php?action=<action>&username=<extra username>&memberid=<extra foreignid>

  • Inquiry Result Good: *success* (You must include the * before and after the word success)
  • Access Enable URL: THIS FIELD IS NOT USED.
  • Access Enable MSG: THIS FIELD IS NOT USED.
  • Access Disable URL: linkdomain/signup/process_segpay.php?action=<action>&username=<extra username>&password=<extra password>&purchaseid=<purchaseid>
  • Access Disable MSG: *success* (You must include the * before and after the word success)
  • Cancel URL: THIS FIELD IS NOT USED.
  • Cancel Match: THIS FIELD IS NOT USED.
  • 2nd Trans Post URL: linkdomain/signup/process_segpay.php?action=<action>&stage=<stage>&approved=<approved>& name=<billname>&email=<billemail>&country=<billcntry>&state=<billstate>&city=<billcity>&address =<billaddr>&transtype=<trantype>&purchaseid=<purchaseid>&transid=<tranid>&price=<price>&user name=<extra username>&password=<extra password>&currencycode=<currencycode>&eticketid=<eticketid>&memberid=<extra foreignid>&session=<extra natssess>&merchantpartnerid=<extra merchantpartnerid>&xsellnum=<xsellnum>
  • 2nd Trans Post Message: (You must include the * before and after the word success): *success*

After you fill in all the appropriate fields, click on the UPDATE button and your profile will be saved. After you have a NATS Postback configuration, you can use that postback configuration in all of your Packages that work with NATS.

Packages

For each SegPay package that uses NATS, enter "nats" into the Result Page field.

Setting up SegPay in NATS

Billers Admin

To begin setting up SegPay as a biller in NATS, go to the Billers Admin. Scroll down to the "Biller" drop-down menu, select SegPay, and click "Add."

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

When prompted, fill in the Merchant ID, User ID, and Access Key that were provided to you by SegPay 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. Enter the E-Ticket ID (Segpay may call this a PackageID) and Order ID (Segpay may call this a PricePointID) that you set up on SegPay's website for each Pay Via Type you wish to use.

Note: As of version 4.0.77.1, NATS now supports Direct Debit (elv) as an processing type for member transactions through SegPay. If you want to add Direct Debit (elv) compatibility to SegPay, please put in support ticket to be upgraded to the latest version of NATS. For information on setting this up once you have it in your nats, see the Direct Debit section below.

You can also use the optional Custom Auth Text and Custom Decline Text fields to determine what you wish to display to the surfer on the SegPay approval and denial pages. Save your changes once you have filled in the required fields here.

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 add Segpay compatibility to. In the "Biller Codes" section on the next page, locate the "SEGPAY Order ID" field, and enter the Order ID you received from SegPay for the join option you are configuring. You can also put in a E-Ticket number in the "SEGPAY E-Ticket Override" fields (CC, Check, and elv), which replaces the E-Ticket that you specified in the "Biller Details" section.

While you can use the Override options provided by SegPay to offer multiple payment types for the same join option, you must set up a separate join option for each payment method you wish to offer through SegPay for your members. See the Direct Debit section below.

Note: As of version 4.1.5.1, when editing a price point in NATS, there is an optional biller detail called "Dynamic Pricing". When this is checked, the biller will use the initial amount set in NATS for the sale, overriding what may be set in the biller for that price point. When this is not checked, SegPay will instead use the initial amount defined in the biller.

Note: As of version 4.1.22.1 or above, Segpay now support Dynamic Recurring feature, when editing the tour setting, there is an optional biller detail called "Dynamic Recurring Billing E-Ticket ID" and option setting "Dynamic Recurring Billing" checkbox under each join option. You will required to setup a Dynamic Recurring Billing E-Ticket ID at Segpay side and used the Dynamic Recurring Billing feature with any join options in NATS.

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 (similar to the several other areas across NATS).

Note: If you input an incorrect E-Ticket ID and Order ID combination in the Sites Admin, your cascade will stop at that step with an error message. Please make sure that you test each E-Ticket ID and Order ID combination you have set up to make sure that they work.

As of version 5.0.4.1, Segpay now supports paypal as a process type. There is no specific eticketid for paypal, it will use the eticketid under 'CC eticketid' instead

Setting up Segpay Direct Debit

To set up Segpay with Direct Debit, you MUST set up separate join option for both currency types: One for GBP, and one for EUR. This will allow surfers to use both currencies and switch between the currency types on the biller form. These join options will have a separate E-ticket ID (provided by Segpay) for each currency type. You will then need to add a country rule to the join options for the correct country(ex Germany for EUR).

Ex codes for all payment types:
Credit Card: 150350:13116
Checks: 150591:13116
Direct Debit EUR: 150607:13194
Direct Debit GBP: 150607:13195

Cross Sells and Upsells

You need to add the following to your Trans Post URL in order to process cross sells: &eticketid=<eticketid>&xref1=<extra xref1>. Segpay will then provide you with an E-Ticket ID for each cross sell. The E-Ticket I.Ds. are formatted as follows: site:product.


You need to add the following to your Trans Post URL in order to process upsells: &eticketid=<eticketid>&upsell=<extra upsell>. Segpay will then provide you with an E-Ticket ID for each upsell. The E-Ticket I.Ds. are formatted as follows: site:product.


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 SegPay from the "Biller" drop-down menu, and 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 SegPay. Fill in your Ref Code here, and click Save Changes.

If you are receiving the cross sale in question, go to the "Incoming Cross Sales" page. Add SegPay 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 fee and length, and the recurring membership fee and length. Finally, fill in the CC E-Ticket ID, Check E-Ticket ID, and Order ID that were provided to you by SegPay. In this section, your "E-Ticket ID" corresponds to your site, and your "Order ID" corresponds to your join option. Once you have filled out the available fields, you will be able to activate your cross sell options.

For upsell redirect, if you wish the redirect to display upsell member record instead of initial sale member record, you must request Segpay to return "PurcahseID" back to NATS during the returnurl redirect.

TokenPlus

SegPay 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 SegPay 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 Credit Card transactions SegPay, you must have One Click approved and enabled for each price point. If this feature is not currently on, please contact SegPay to have them enable it.
Note: One Click transactions are only available for Credit Card sales.

PackagePlus

SegPay now support Packageplus feature, it will allow you to change the amount that a consumer will be charged on his/her next bill date. However, SegPay does not currently support switching to an option with a different rebill cycle.

In 5.0.5.1 and above: SegPay Package Plus now supports package upgrades, based on the recurring amount. Segpay now allows for a different recurring period between the current and the new price point. This change also allows Segpay to charge the member during the package upgrade process

SignupPlus

As of NATS version 5.0.2.7, Segpay supports Signup Plus

UpgradePlus

UpgradePlus lets you shorten a Member's Trial by offering them incentives to upgrade to a full member. 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 members that paid for the full month.

To use upgrade plus, the price points in NATS Segpay need to be set up to allow "instant conversion". To do this, you must contact Segpay. Without the allowance of "instant conversion", members connected to that price point will not be allowed to upgrade. After "instant conversion" is allowed, Segpay will send a TransGUID within their "initial" post to process_segpay. Then, members connected to that price point will have an "upgradeid" connected to their information, allowing the upgrade to take place.

Notes

Change the minimum characters on your NATS join form to 8. To do this, edit your Join form and locate the this line:

<TR><TD class="join_name">Username:</TD><TD class="join_value"><input class="join_input" type="text"
name="signup[username:1:6:16:::username_check]" value="{$vars.username}"><span class="join_error">{if $errors.username}<br>{$errors.username}</span>{/if}</TD></TR>

Change the '6' into an '8' and it will work fine.