Report on leads
A report is a document used as the basis for renumeration for leads. Read more in the General Terms and Conditions of the YooMoney Service.
The report should be sent to offer_clients@yoomoney.ru once a month.
You need to set the email address to be used for sending the reports to the YooMoney service in advance. Reports from other addresses will not be accepted.
Report format
The report is generated as a CSV file (see IETF RFC4180).
The semicolon (;) is used as the field divider.
Encoding is UTF‑8.
You can make a report in XLS format (for example, in Microsoft Excel) and save the file in CSV format (semicolon dividers).
Filename format:
redeem_file_partnerID_YYYY1-MM1-DD1_YYYY2-MM2-DD2.csv
where:
partnerID
is the name of the store in Latin, issued in the YooMoney service;YYYY1-MM1-DD1
is the start date of the reporting period (from, inclusive);YYYY2-MM2-DD2
is the end date of the reporting period (until, not including).
Example of the filename of a Store report for August 2017
report_file_magazin_2017-08-01_2017-08-31.csv
Report contents
The file with the report contains the title, data about leads, and the total amount of remuneration for YooMoney.
Fields in the report
Field | Type | Description |
---|---|---|
clickId | string | Unique ID of a click. Required, if pinContent is missing |
pinContent | string | Promo code content (alphanumeric string) is needed by the user to get a discount or bonus. Required, if clickId is missing |
campaignFee | varchar (30) | YooMoney’s remuneration for this offer. Required |
ymCampaignId | string | Campaign ID in YooMoney. Optional |
transactionId | string | Order ID in merchant’s system. Optional |
sceneRedeem | string | Place of use of the offer (website or physical address of the specific store when the offer is used offline). Optional |
redeemTime | dateTime | Date and time when the offer was redeemed in the YYYY-MM-DDThh:mm:ss.fZZZZZ format.Optional |
orderAmount | varchar (30) | Purchase cost in rubles. Optional |
Creating a report
The header is set in the first line. It contains all the fields in the report. The set of fields is fixed, but you don’t need to fill in empty fields.
Header example
clickId;campaignFee;ymCampaignId;transactionId;sceneRedeem;redeemTime;orderAmount
A separate row is formed for each lead made during the report period.
Example of a row with information for one lead
cc1ac215ca9305js26282363id1821s7;150;28014;638950-200;redcube.ru;2017-08-06T19:00:00.000+04:00;1554
Example of a row with empty fields
get300;80;34099;;;;
If your customers use the offer at a retail outlet and not on the website, you must specify the used pin code in the
pinContent
parameter. The clickId
parameter for such cases is irrelevant.In the last row of the report, specify the total amount of YooMoney’s remuneration for the reporting period: it must match the total value of the
campaignFee
field for all leads in the report.Example of a row with the remuneration amount of 3,000
;3000;;;