Difference between revisions of "Payvia Dump Formats"

From Offerit
Jump to: navigation, search
(Creating A PayVia Type)
Line 2: Line 2:
 
| show_payments_admin_section = true
 
| show_payments_admin_section = true
 
}}
 
}}
 
[[Offerit]] gives you the option to create your own [[Pay Via Types]] for use with compatible payment options. This allows you to choose different methods of sending [[Ct#Affiliate|affiliate]] payments, as well as the option of configuring PayVia options how you want.
 
 
[[File:Admin_Pay_Via_Types.png|750px|List of PayVia Types]]
 
 
== Creating A PayVia Type ==
 
To create a new [[Pay Via Types|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".
 
 
[[File:Admin_New_Pay_Via_Type.png|Adding a New PayVia Type]]
 
 
You will then be prompted to fill out a set of required fields:
 
* '''Pay Via 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.
 
* '''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.
 
* '''Dump Format''' - Choose an appropriate dump format to use. For more information, please see the [[Creating and Editing PayVia Options and Dump Formats#Pay Via Dump Formats|Pay Via Dump Formats]] section of this article.
 
*'''Enabled Default Rule''' - This is the default rule setup for each Pay Via type.
 
**Enabled: All affiliates are able to choose this payment method, unless there is a specific disable rule setup in the Pay Via Rules.
 
**Disabled: None of your affiliates will be able to utilize this payment method, unless they match an enable rule setup in the Pay Via Rules.
 
 
After configuring all available fields, click Save to save your changes. You can edit this information at any time with the pencil icon.
 
 
=== Editing Pay Via 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 [[Pay Via Types|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.
 
 
[[File:Admin_New_Pay_Via_Fields.png|750px|PayVia Fields]]
 
 
* '''Name''': The name of the field as shown to affiliates (ex: ePassporte ID, user ID, etc.)
 
* '''Type''': Choose to display a text box or a multiple choice selection
 
* '''Required''': Whether or not the field is a required field (ex: for the ePassporte ID, if it's not required, how would you pay them?)
 
* '''Minimum''': The minimum character length for the field (ex: 1)
 
* '''Maximum''': The maximum character length of the field (ex: 16)
 
* '''Unique''': Prevents multiple affiliates from using the same value for this field
 
* '''Check Function''': Validates input using this function.  Use NONE to disable validation. (ex: alnum_space_check makes sure the input is alphanumeric characters and allows spaces.)
 
 
The four Action icons next to a field let you edit, disable/enable, or change the order the options appear on the affiliate's sign-up form.
 
  
 
== Pay Via Dump Formats ==
 
== Pay Via Dump Formats ==

Revision as of 15:11, 12 August 2012

Offerit
For Affiliates
Automatic SubIDs
Affiliate Stats Dumps
Linkcode
Link Groups
Affiliate Custom Pixels
Affiliate Host and Post
Offerit 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
Offerit Setup
Creating Admin Accounts
Tracking Domain
Edit Affiliate Text
Edit CSS Colors
Getting Started Admin
Offerit Quick-Start Guide
Tracking in Offerit
Pixel Builder
Offerit 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
Visitor Actions 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
Offers
Offer Setup
Affiliate Referrals
Tracking Domain
Commissions
Commission Changes
Suppression Lists
Pixel Builder
ID Numbers
Offer Partner
Offer/Landing Page Redirection
Setting Rules
Admin Host and Post
Offer Post URLs
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
Payza
Creatives Admin
The Creatives Admin
Add New Creatives
Add New Creative Type
Offeritcode
Code Builder
Track and Strack
Setting Rules
  Default Creative Types
Creative Types
Image Banners
Flash Banners
Dynamic Text Banners
Feeds
Mailers
Video Download
Video Embed
Page Peels
IM Popups
Footer Ads
Page Ads
Overlays
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
REST API
General
Offerit REST API Overview
GET /service/ping
PATCH /service/set_currency_exchange_rates
Advertiser
PATCH /advertiser/edit_advertiser
POST /advertiser/add_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
GET /affiliate/decode_trackingcode
PATCH /affiliate/edit_affiliate
PATCH /affiliate/payvia
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
Config
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
Creative
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
Customer
PATCH /customer/set_customer_details
PATCH /customer/lock
PATCH /customer/unlock
PATCH /customer/forget
GET /customer/export
Offer
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
Reporting
GET /report/profitloss
GET /report/transaction
Transaction
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
POST /transaction/approve_pending_transaction
GET /transaction/click_detail
SOAP API (*deprecated*)
API
Add Affiliate
Add Affiliate Sale
Add Offer
Approve Transaction
Creative Types
Decode Offeritcode
Deny Transaction
Disable Affiliate Landing Page
Edit Affiliate Sale
Enable Affiliate Landing Page
Get Affiliate Stats
Get Allowed Affiliates
Get Landing Page Details
Get Offer Details
Get Offer List
Get Profit Loss Report
List Affiliate Details
List Affiliate Subaffiliates
Ping
Set Affiliate Status
Set SubAffiliate Status
Set Member Details
Record Affiliate Click
Misc.
Rules
Freeform Date
Affiliate Custom Signup
Offeritcode
Tracking in Offerit
Offerit Logos
Void Conversions Remotely

Pay Via Dump Formats

Dump formats are used to format and display your payment after they've been stored. To view your dump formats, go to Payments Admin and click the "Dump Formats" tab to view the current available dump formats.

Current Pay Via Dumps

You can create a dump format by typing in the name under "New Dump Format". Dump formats have the following sections:

  • Name: the name of the dump format.
  • Dump Header: What fields are displayed at the top/beginning of a dump.
  • Entry Header: This is displayed before the affiliate's payment.
  • Entry: This is the affiliate's payment data.
  • Entry Footer: This is displayed after the affiliate's payment.
  • Dump Footer: This is displayed at the very end of the dump.

Configuring PayVia Dump Formats

All the fields that you created in the PayVia form are available here, but with different names. Starting with the name you gave the field, the name is:

  • prefixed with "$affiliate.payvia."
  • all spaces are changed to underscores

For example, the "User ID" field becomes {$affiliate.payvia.User_ID}.

The easiest way to create your own dump format is to duplicate a similar format and then make the necessary changes. Offerit currently ships with more than 20 formats, so finding a similar format should be easy.

See Also