NATS For Networks Payvia Types

From TMM Wiki
Jump to navigationJump to search
NATS For Networks
For Affiliates
Automatic SubIDs
Affiliate Stats Dumps
Affiliate Custom Pixels
Affiliate Host and Post
Affiliate Area
Affiliate Account Details
Affiliate Account Change Log
Affiliate Creatives
Affiliate Creatives Search
Affiliate Settings
Affiliate Custom Pixels
Affiliate Linkcodes
Affiliate Linkcode Settings
Affiliate Login History
Affiliate Messages
Affiliate Dashboard
Dashboard Key Statistics
Dashboard Statistics Summary
Affiliate Payment History
Quick Links
Affiliate Referrals Report
Affiliate Referring URL Report
Affiliate Remote Login
Affiliate Signup
Affiliate Statistic Filters
Affiliate Statistic Views
Affiliate SubIDs
NATS For Networks Setup
Creating Admin Accounts
Tracking Domain
Edit Affiliate Text
Edit CSS Colors
Getting Started Admin
Quick Start Guide
Tracking in NATS For Networks
Pixel Builder
Postback Examples
Replacement Variables
Currency Exchange Rates
Admin Dashboard
The Admin Dashboard
Reporting Admin
The Reporting Admin
Track and Strack
  Report Breakdowns
Profit and Loss Report
Subscription Report
Transactions Reports
Affiliate Ratios Report
Affiliate Managers Report
Referral Tier Payouts Report
Referral Signup Payouts Report
Additional Commissions Report
Graphical Affiliate Comparison Report
The Single Day Comparison Report
Actual Affiliate Payments Report
Offers Admin
The Offers Admin
Offer Setup
Affiliate Referrals
Tracking Domain
Commission Changes
Suppression Lists
Pixel Builder
ID Numbers
Offer Partner
Offer/Landing Page Redirection
Setting Rules
Admin Host and Post
Offer Goals
Affiliates Admin
The Affiliates Admin
ID Numbers
Affiliate Managers
Affiliate Referrals
Affiliate Activation
Admin-Only Settings
Affiliate Overrides
Creating Admin Accounts
In-House Accounts
Add Manual Sale
Manual Invoice
Affiliate Documents
Affiliate Enabled Offers
Change Affiliate Status
Account Changes
Advertisers Admin
The Advertisers Admin
Account Changes
Advertiser Invoices
Generate Invoice
Advertiser Approval
Change Advertiser Status
Customers Admin
Customers Admin
Manually Adding a Customer
ID Numbers
Payments Admin
The Payments Admin
Payvia Types
Payout Periods
Payvia Dump Formats
Payment Dump Entry Numbers
Payment Dump Variables
Check Functions
Setting Rules
Payment Methods
API Overview
GET /service/ping
GET /service/set_currency_exchange_rates
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
GET /affiliate/decode_trackingcode
PATCH /affiliate/edit_affiliate
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
GET /config/get_global_void_ips
GET /config/get_global_post_ips
GET /config/get_global_hostnpost_ips
POST /config/add_global_void_ip
POST /config/remove_global_void_ip
POST /config/add_global_post_ip
POST /config/remove_global_post_ip
POST /config/add_global_hostnpost_ip
POST /config/remove_global_hostnpost_ip
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
GET /offer/get_conversion_caps
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
GET /offer/get_details
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
GET /report/profitloss
GET /report/transaction
PATCH /customer/lock
PATCH /customer/unlock
GET /customer/export
PATCH /customer/forget
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash
POST /transaction/process_void
POST /transaction/process_chargeback
POST /transaction/process_reversal
GET /transaction/click_details
Creatives Admin
The Creatives Admin
Add New Creatives
Add New Creative Type
Tracking Code
Code Builder
Track and Strack
Setting Rules
  Default Creative Types
Creative Types
Image Banners
Flash Banners
Dynamic Text Banners
Video Download
Video Embed
Page Peels
IM Popups
Footer Ads
Page Ads
Communications Admin
The Communications Admin
Add News Item
Sending Messages
Signup Questions
Configuration Admin
The Configuration Admin
Affiliate Signup Postback URL
Edit Affiliate Text
Edit CSS Colors
Freeform Date
Affiliate Custom Signup
Tracking Code
Tracking in NATS For Networks
Void Conversions Remotely

Payvia types are methods of payment that are recognized by NATS For Networks and used to pay affiliates for redirecting traffic to your offers. You can access all your available Payvia types through the Payments Admin. To do so, go to the Payments admin and click the "Payvia Types" tab on the side of the page.

You will then be taken to a list of your currently configured affiliate payment (Payvia) types. The default types included in NATS For Networks are:

  • Check
  • Domestic Wire
  • ePassporte
  • Inteca
  • International Wire
  • Payoneer
  • Paypal

Currently Configured Payvia Types

The action icons on the left allow you to enable / disable the Payvia by default, edit, and set up rules for the Payvia.

Editing Your Settings

To edit your Payvia type settings, click the pencil icon next to the payment method you wish to configure. You will then be able to edit the available fields in the Payvia Type list:

  • Payvia Type - The name of your new Payvia type.
  • Description - The description of the Payvia type that your affiliates will see.
  • Minimum Payment - A comma-separated list of available payment options that affiliates can select from. See the minimum payment section below for more information.
  • Cost/Bonus Per Payment - Allows you to set a fee to charge affiliates per payment sent, or add a bonus to affiliate payments. You can set it to zero to disable any costs, set it to positive to charge affiliates, or set it to negative to give affiliates a bonus on each payment. See the Cost/Bonus section below for more information.
  • Dump Format - Choose an appropriate dump format to use. For more information, please see Payvia Dump Formats.
  • Enabled Default Rule - This is the default rule setup for each Payvia type.
    • Enabled: All affiliates are able to choose this payment method, unless there is a specific disable rule set up in the Payvia Rules.
    • Disabled: None of your affiliates will be able to utilize this payment method, unless they match an enable rule set up in the Payvia Rules.

Editing Your Payvia Settings

Minimum Payment

Minimum Payments are the minimum earnings required for affiliates to be paid by an NATS For Networks commission. You can set these minimums yourself through the "Payvia Types" tab at the top of the payments admin. Choose the Payvia type you would like to edit, then click the Edit Details icon. You will then be able to change your minimum payment options for affiliates.

The minimum payment field is a comma-separated field where you can input as many values as you would like. The affiliate will then be able to choose their minimum payment from the list of options you have provided.

There are a couple of reasons for minimum payments -- to avoid having to repeatedly send small amounts of money, and to minimize transactional costs, such as fees for bank wires and ePassporte.


The Cost(+)/Bonus(-) column is used to set amounts of money to add or subtract from sent payments for using certain join options. This can be used to persuade affiliates to use a certain Payvia type, or to dissuade them from using other Payvia types.

Setting your Cost/Bonus is a similar process to setting minimum payments -- go to the payments admin, navigate to the Payvia Types section, and click the edit icon next to the type you wish to edit.

To charge an affiliate for using a Payvia type, fill in the Cost/Bonus column with a positive dollar amount. This will subtract the selected amount from an affiliate's payment when they use that Payvia type.

To give an affiliate a bonus for using a Payvia type, fill in the Cost/Bonus column with a negative dollar amount. This will add the selected amount from an affiliate's payment when they use that Payvia type.

Payvia Rules

With the purple arrows icon, you can set specific rules for your Payvia type. Rules are used so only certain affiliates can use a Payvia type. For more information, see our setting rules page.

Hidden Payvia Options

To create hidden affiliate Payvia option, go to Payments Admin, click the Payvia Types tab, and click the Payvia Rules icon. Enter a rule that determines which affiliates see this Payvia, and click Add. For example: to hide a Payvia from all affiliates, select the following options:

  • Type: IGNORE
  • Affiliate: ALL
  • Country: ALL
  • Start Date/Time: NOW
  • End Date/Time: FOREVER

Payvia Rules

You can manually add an affiliate to a hidden Payvia by going to Affiliates Admin, finding the affiliate, clicking the Edit Affiliate Details icon, and modifying their Payment Method.

Creating a New Payvia Type

NATS For Networks gives you the option to create your own Payvia Types for use with compatible payment options. This allows you to choose different methods of sending affiliate payments, as well as the option of configuring Payvia options how you would like.

If you want to add another Payvia type that is not set up in NATS For Networks, To create a new Payvia type, click on the "Payvia Types" tab on the side of the page in the Payments Admin. On the next page, scroll down to the bottom, enter a name into the "New Payvia Option" text box at the bottom, and click "Add".

Adding a New Payvia Type

You will then need to fill out all required fields, same as mentioned above. You can edit this information again at any time with the pencil icon. When finished, hit save. You then will have to configure your Payvia type for its unique needs.

Configuring Payvia Fields

To edit the fields of your new Payvia option, click the "Configure" icon under the Actions column. This option is only available for the Payvia types you have created yourself - the default options can not be edited in this way. The next page allows you to edit the Payvia type's structure, as well as available fields. You can add a new field to the structure by filling out a new row and clicking Save.

Payvia Fields

  • Field Name - The name of the field the affiliate fills out. Examples include a "Pay To" field for checks, a "User ID" field for ePassporte, and an "Account Number" field for Domestic Wires.
  • Type - Choose if you want the field to be a text box or a multiple choice list.
  • Required? - Marks the field as necessary to be filled in (ex: for the ePassporte ID, if it's not required, how would you pay them?).
  • Minimum - The minimum amount of characters for the field.
  • Maximum - The maximum amount of characters for the field.
  • Unique? - Whether or not the value in the field has to be unique (Prevents multiple affiliates from using the same value for this field)
  • Check Function - Checks if the field was properly populated. An example is alnum_letter_space_check, which verifies if the entry is alphanumeric, contains letters, and allows spaces. For more information, visit the Check Functions wiki article.

When you have filled in all available form fields, click Add to create your new Payvia field.

The action icons on the right hand side allow you to edit the values for your field, disable or enable the field, and change the order of your available fields.