Publisher Transaction Queries

From Wiki

Jump to: navigation, search

Go to FR version

Contents

Introduction

A transaction query is a transaction manually added to the system by a publisher. The circumstances for this to occur would be when you believe you have an untracked sale, incorrect commission or when you would like to dispute a declined transaction.

Further examples:

  • Untracked

This can happen for a number of reasons; tracking maybe down on your confirmation page or a user may block 3rd party cookies.

  • Incorrect

An publisher wishes to dispute the commission amount of a transaction.

  • Declined

An publisher would like a transaction re-validated as they believe it to be a valid transaction.

This guide provides details on how to submit transaction queries to advertisers via FTP or manual upload.

Please ensure you add the appropriate information or the transaction may not be validated by the advertiser.

How it works

When you add a transaction query into the system, it will go into a new transaction query system in the advertisers’ account. The large majority of Awin's advertiser base have 75 days to review/amend a transaction query or it will be automatically approved.

Methods

There are two methods in which you can provide your transaction queries to us - automatically via ftp, or a manual upload via your account.

FTP Upload

To automate the process via FTP you will need to have a personal FTP account or alternatively you can contact support and request an Awin FTP account. Once you have got your FTP username and password you need to click on Transaction Query (located in the right hand side menu of your user area) then on the Automated Data Upload.

You will now be able to enter your username and password along with your file type, schedule and whether or not you wish to receive email reports about the result of the process.

Next, connect to your FTP account and create a folder called ‘transaction_queries’ in the root directory.

Open up this directory and upload your CSV or XML file with the name of data.csv (or data.xml). If you have selected to receive reports on the processing of your file (recommended) then you will receive an e-mail after your file has been processed.

Note: We only update new files, i.e. if you have selected daily but only upload a new file every week – then we will automatically detect this and only process it when it has been updated.

Manual Upload

When logged into your publisher account, access Support > Transaction Queries from the navigation menu. From the options on this page select 'Manual Data Upload'. You will then need to select either an XML or CSV file that conforms to our data file specification and click on the upload button.

You will then receive a message informing you of what lines have / haven’t been uploaded and why.

Data File Specification

Your data file should conform to the structure below before uploading to your account.

Specification Table

Field Name Type Description Example
enquiry_id Integer, Max: 10 char. Uniquely identifies the publisher in our system 123456371
type enumeration Can be ‘declined’, ‘incorrect’ or ‘untracked’ untracked
click_ref Alpha numeric – Max: 50 char Uniquely identifies the sale for the publisher clickref12345
merchant_id Integer, Max: 8 char. Uniquely identifies the merchant/advertiser in our system of which the transaction query is related to. 1234
date Date time Datetime of the order (yyyy-mm-dd HH:ii:ss) 2012-04-25 23:11:26
amount decimal(7,2) Sale value without currency symbol 5.00
commission decimal(7,2) Commission value without currency symbol 1.00
reference Text Max 16,777,215 char Order reference, or any data to uniquely identify transaction. Commission received was 4.54GBP when it should have been 5.54GBP
customer_reference Text Max 16,777,215 char publisher-entered data to identify themselves as a customer to the advertiser customerrefSD2343
Description Text Max 16,777,215 char Any further information for the advertiser regarding the transaction. Commission received was 0.80GBP when it should have been 1.00GBP
Currency Text publisher-entered data to identify the currency the transaction was carried out in EUR
Timezone Text publisher-entered data to identify the timezone of the transaction Europe/Dublin


Transaction queries example:

enquiry_id merchant_id type click_ref amount commission date customer_reference reference description
3825 3 untracked CR1 (or 0) 650.99 23.44 YYYY-MM-DD 00:00:00 111111-000216 order-ref123 john@gmail.com

CSV

All CSV files (http://en.wikipedia.org/wiki/Comma-separated_values) need to have all values enclosed in double quotes and separated by commas. Each row needs to be separated by a single new line. The first line in the CSV file must contain the correct field headings.

CSV example

enquiry_id,merchant_id,type,click_ref,amount,commission,date,customer_reference,reference,description,currency,timezone
123456371,3727,untracked,clickref12345,5.00,1.00,2012-04-25 23:11:00,customerrefSD2343,orderref123447,sale untracked,EUR,Europe/Dublin

XML

All XML files (http://en.wikipedia.org/wiki/Xml) need to be correctly formatted.

XML example

<?xml version="1.0" encoding="ISO-8859-1"?> 
<enquiries>
<enquiry>
<enquiry_id>101</enquiry_id>
<type>declined</type>
<click_ref>25</click_ref>
<merchant_id>1001</merchant_id>
<date>2008-03-20 23:40:09</date>
<amount>4.50</amount>
<commission>1.00</commission>
<reference>7723123</reference>
<customer_reference>email@address.com</customer_reference>
<description>this purchase was declined, why?</description>
<currency>EUR</currency>
<timezone>Europe/Dublin</timezone>
</enquiry>
<enquiry>
<enquiry_id>102</enquiry_id>
<type>incorrect</type>
<click_ref>27</click_ref>
<merchant_id>1001</merchant_id>
<date>2008-03-22 01:22:24</date>
<amount>312.50</amount>
<commission>6.55</commission>
<reference>order # 554212</reference>
<customer_reference>554212</customer_reference>
<description>Purchase amount was for £75.28 but only £68.10 was
tracked</description>
</enquiry>
<enquiry>
<enquiry_id>103</enquiry_id>
<type>untracked</type>
<click_ref>28</click_ref>
<merchant_id>1001</merchant_id>
<date>2007-04-01 02:21:09</date>
<amount>61.90</amount>
<commission>4.02</commission>
<reference>J55432-1212</reference>
<customer_reference>email@address.com</customer_reference>
<description>Advantage Card Number: 77712312</description>
</enquiry>
</enquiries>


FTP Schedule

Our FTP processing gives you the choice between daily and weekly processing. Weekly processing happens at 0200 every Sunday. Daily processing happens at 0200.

Transaction Query Report

You can view the transaction queries, including the current statuses, by selecting “Transaction Query Report”.

You are able refine your search by advertiser Name/ID, Status and Date. You can download the report as CSV file.

Check transaction

Check to see if a transaction will be accepted into the system. You can search by adding the Order Ref, Advertiser ID and Date, as shown below.

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button