Difference between revisions of "NATS5 Cascades"

From TMM Wiki
Jump to navigationJump to search
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
__TOC__
 
__TOC__
  
<!-- Cascades are lists of steps that NATS will send the surfer when it comes time for payment. These steps may include biller interaction, displaying special templates ore redirecting to a different URL.
+
A cascade sends surfers through multiple billers based on their payment option in order to encourage more customers to sign-up. If a customer is rejected from one billing processor, the cascade will put them through all available billing options until they are either accepted by a processor or rejected by all available processors.
  
When a surfer goes to the NATS pre-join page, they will have to select a cascade. Once the surfer selects a cascade, NATS will send that surfer to the first step in that cascade. If the surfer is denied by the first biller, NATS will send the surfer to the next biller in the cascade. This process continues until the surfer is approved or NATS reaches the end of the cascade list.
+
The Cascades list displays a list of all the cascades you have set up in your NATS, and allows you to add more cascades, delete cascades, and access the [[NATS5 Cascade Overview|Cascade Overview]].  
<br>
 
<br> -->
 
 
 
The Cascades list displays a list of all the cascades you have set up in your NATS, and allows you to add more cascades, delete cascades, and access the [[NATS5 Cascade Overview|Cascade Overview]]. To access this page, click the "Cascades" section under the Billers section.  
 
  
 +
== Cascades Table ==
  
== Cascades Table ==
 
 
[[File:Cascades-Management.jpg|border|800px]]<br><br>
 
[[File:Cascades-Management.jpg|border|800px]]<br><br>
 
The Cascades table displays all of the cascades and general information about each cascade. This information includes:
 
The Cascades table displays all of the cascades and general information about each cascade. This information includes:
 
*'''Description''': The description that is displayed on the join form.  
 
*'''Description''': The description that is displayed on the join form.  
 
*'''Type''': The type of the cascade. Options for cascade types are Standard, Automatic, Gateway One Step, and Hidden.  
 
*'''Type''': The type of the cascade. Options for cascade types are Standard, Automatic, Gateway One Step, and Hidden.  
*'''Weight''': XX
+
*'''Weight''': Used to define the order of cascades on the Pre-Join page, which cascade is used when 2 or more cascades have the same name, and to define special cascades. See more detail below.
 
*'''Target Countries''': The cascade will only be available to surfers coming from these selected countries.  
 
*'''Target Countries''': The cascade will only be available to surfers coming from these selected countries.  
 
*'''Exclude Countries''': The cascade will not be available to surfers coming from these selected countries.
 
*'''Exclude Countries''': The cascade will not be available to surfers coming from these selected countries.
Line 40: Line 36:
 
The cascade description will be the text displayed on your join form when choosing your payment option. The short name is the unique identifier for the cascade. <br>
 
The cascade description will be the text displayed on your join form when choosing your payment option. The short name is the unique identifier for the cascade. <br>
 
<br>
 
<br>
 +
 +
== Cascade Weights ==
 +
 +
Cascade Weights can be used in Multiple Ways:
 +
* Control the order of Cascades listed on the pre-join page within the Member sign-up process. For example:
 +
** If 3 Cascades are available to the member signing up, all three will be displayed on your join form. The order will be based on the weights given for all three. The higher number is also first on the list.
 +
* When 2 cascades have the same Description, NATS will randomly pick 1 of them to be used within the signup process.
 +
* Create Special Cascade Types:
 +
** Automatic: Automatic cascades allow surfers to bypass the standard NATS pre-join form and go directly to a biller join form. As a result, the autocascade feature will also bypass the authentication procedure in the NATS pre-join form.
 +
** Gateway One Step: This allows surfers to bypass the NATS pre-join page, and instead combines the required information of the pre-join onto a single gateway join page that surfers can register on.
 +
** Hide Cascade: This type of cascade is completely functional but will not automatically used on any site's pre-join forms. You can place a hidden cascade on your join form template by hard-coding the cascade option into a radio button or a join form submit button.
  
 
[[Category:NATS5]]
 
[[Category:NATS5]]

Latest revision as of 11:40, 8 August 2019

NATS 5
Billers Section
Biller Management
Biller Overview
Cascades
Cascade Overview
Cascade Weight
Taxes
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

A cascade sends surfers through multiple billers based on their payment option in order to encourage more customers to sign-up. If a customer is rejected from one billing processor, the cascade will put them through all available billing options until they are either accepted by a processor or rejected by all available processors.

The Cascades list displays a list of all the cascades you have set up in your NATS, and allows you to add more cascades, delete cascades, and access the Cascade Overview.

Cascades Table

Cascades-Management.jpg

The Cascades table displays all of the cascades and general information about each cascade. This information includes:

  • Description: The description that is displayed on the join form.
  • Type: The type of the cascade. Options for cascade types are Standard, Automatic, Gateway One Step, and Hidden.
  • Weight: Used to define the order of cascades on the Pre-Join page, which cascade is used when 2 or more cascades have the same name, and to define special cascades. See more detail below.
  • Target Countries: The cascade will only be available to surfers coming from these selected countries.
  • Exclude Countries: The cascade will not be available to surfers coming from these selected countries.


Filtering

To filter the Cascades Table, click the "Filter" button at the top-right of the page, under the "Add A Cascade". You can choose to filter your results by enabled cascades only, disabled cascades only, or view all cascades, as well as filtering by the billers used in the cascade.
Cascade-Management Filter Widget.jpg

Deleting & Restoring a Cascade

To delete a cascade, click the "Actions" button next to the cascade you would like to disable, and click "Delete this Cascade".

To restore a cascade, locate the disabled cascade that you wish to restore. This cascade will have a "Disabled" tag next to its description to clarify that it is a disabled/deleted cascade. Click the "Actions" button to the right of that cascade and click "Restore this Cascade". This will enable the cascade again and it will be available for use.


Adding a Cascade

To add a cascade, click on the "Add a Cascade" button at the top-right of the page.

Cascade-Management Add Cascade.jpg

This widget above will appear on the page, where you will fill in the cascade description and short name.
The cascade description will be the text displayed on your join form when choosing your payment option. The short name is the unique identifier for the cascade.

Cascade Weights

Cascade Weights can be used in Multiple Ways:

  • Control the order of Cascades listed on the pre-join page within the Member sign-up process. For example:
    • If 3 Cascades are available to the member signing up, all three will be displayed on your join form. The order will be based on the weights given for all three. The higher number is also first on the list.
  • When 2 cascades have the same Description, NATS will randomly pick 1 of them to be used within the signup process.
  • Create Special Cascade Types:
    • Automatic: Automatic cascades allow surfers to bypass the standard NATS pre-join form and go directly to a biller join form. As a result, the autocascade feature will also bypass the authentication procedure in the NATS pre-join form.
    • Gateway One Step: This allows surfers to bypass the NATS pre-join page, and instead combines the required information of the pre-join onto a single gateway join page that surfers can register on.
    • Hide Cascade: This type of cascade is completely functional but will not automatically used on any site's pre-join forms. You can place a hidden cascade on your join form template by hard-coding the cascade option into a radio button or a join form submit button.