Merchant Reporting Tool Interface guideline

Transcription

1 Merchant Reporting Tool Interface guideline For Merchant Service Center (MSC) Table of Contents 1) Introduction 2 2) Log In 2 New Users to Merchant Service Center 2 Existing Users of Merchant Service Center 3 3) Merchant Reporting Dashboard 4 4) Transaction Reporting Tool 5 a) Search filters for transaction report 5 Merchant IDs 6 Transaction ID 6 Date filters 7 Reporting criteria ID 7 Merchant Client ID: 8 Disposition states 8 Column(s) online display filter 8 Reset Filter 9 b) Online results 9 Transaction Parameter glossary 9 c) Details [button] 11 Payment Detail glossary 12 d) Download Report 14 5) Settlement Report 15 a) Search filters for the Settlement Report 16 Merchant Ids 16 Date filter 17 Reporting criteria ID 17 Merchant Client ID: 17 Invoice Number 18 Column(s) filter 18 Reset Filter 18 b) Online results 19 Settlement Parameter glossary 19 c) Download report 21 1

2 1. Introduction The following document outlines the entire reporting functionality of the paysafecard Merchant Service Center. Merchant reporting dashboard Access your Merchant dashboard report for a real-time overview on transaction activity. This will help you fine tune your monetization strategy with a snapshot on top performing countries and transactions over the last 7 days. Transaction report Use our transaction reporting tool to access real time activity through the Merchant Service Center. On all reports you can view the results online or download them to CSV. The Transaction report is used for those investigations into incomplete transactions with filter criteria allowing you to pinpoint very specific cases. Settlement Transaction report Use the settlement report to analyse the completed transactions with a full breakdown of fees and more. Accessing Merchant reporting functions Access to the reporting tool must be granted by your company Super-user. Your company Super user is in charge of all access to functions within Service Center. Please contact your company representative to arrange for the necessary access as paysafecard are unable to create the necessary roles and permissions for you! For full access to the Settlement and Transaction reporting functions a user must be granted the Finance role to have the necessary permissions. Other roles like Technical will have access to only the Merchant reporting dashboard and the Transaction report and all technical touch points of the service center. 2) Log In Once your company Super user has created your access, you need to complete the following steps: New Users to Merchant Service Center a) Your company Super user invites you from the Merchant Service Center and assigns your role b) You will receive an inviting you to paysafecard Service Center 2

3 c) Click the link in this and you are redirected to our authentication page d) Use Google Authenticator to complete the first time 2 Factor login steps Click here for our 2 Step Login guide e) Set your new password and confirm f) You will be logged in Existing Users of Merchant Service Center g) You are on the Merchant Login page h) You provide a valid 2 Factor authenticated PIN i) You provide a valid Username and Password j) You are logged in successfully 3

4 3) Merchant Reporting Dashboard The Merchant Reporting Dashboard provides you with a performance snapshot of 7 days for each MID you have (only one can be selected at any time.) The dashboard is located in the left Navigation menu under Reporting. This is the first page that users with Technical and Finance role will see. Per MID you get the following information: Number of transactions today Volume transactions today in MID currency Average transaction amount today in MID currency Last 7 days view of the transaction count Last 7 days view of transaction volume in MID currency The top 5 countries in terms of transaction count over the last 7 days The comparison of desktop vs mobile transactions (%) in last 7 days All values are based on completed transactions If you have more than 1 MID listed under your account and you wish to view the performance of another, please select your MID from the drop down menu as shown below: Please note the reporting dashboard is to be used for tracking purposes. It should be noted that the final transaction overview is reflected in your invoice. 4

5 4) Transaction Reporting Tool View your transactions in real-time with the transaction reporting interface. Below is a screen shot of the transaction report user interface. a) Search filters for transaction report NOTE THE FOLLOWING CONSTRAINTS: Date from and Date to are mandatory, except when searching for a specific Merchant Transaction ID (MTID) Download report csv limitation of 200,000 rows Online results are limited to 1500 rows. If there are more based on your search criteria you will get an info message asking you to download for the full view. Maximum search date range is 3 months 5

6 Merchant IDs When you have more than 1 MID assigned to your account you can search for multiple MID s. To build your list of MID s please select them one by one. If one has been selected from the drop down list, it will appear dark grey in color as shown below. Default view is All as shown below: Transaction ID Searching for a specific transaction or getting partial results with the symbol % can be done only in the field Transaction ID (MTID). list all transactions that include e.g. xyz, use following: %xyz% list all transactions that start with e.g. xyz, use following: xyz% Date filter criteria can be left blank when searching for a specific transaction ID. 6

7 Date filters The date selection is in the form of a date picker or you can manually enter in the date dd/mm/yyyy. By default, the Time field is (Date from) from = 00:00 and (Date to) until = 23:59, however you can manually define the time range of your search. NOTE: maximum allowed search: 3 months at once This applies to larger Merchants only: if we identify there are simply too many transactions due to your volume, we will ask you to refine your search to 7 days or reduce the number of MIDs in the search. Reporting criteria ID If reporting criteria has been configured for your Merchant account, then it will appear here automatically for selection. You can define 1 or more Reporting criteria ID(s) however as with the Merchant ID the default is to show all. 7

8 Or default is as shown below Merchant Client ID: Now you can search on the Merchant Client ID to help target your search to individual customer accounts of your company. The field is a free text input field. Disposition states You can filter on all of the disposition states shown. We have listened to business partner feedback and added the Status before expiration field. This is particularly useful for identifying cases where a successfully authorized payment has not been captured, or cases where the customer did not authorize the payment at all. Disposition state INITIATED REDIRECTED AUTHORIZED SUCCESS CANCELLED_MERCHANT CANCELLED_CUSTOMER EXPIRED Description The initial state of a payment after is has been successfully created. The customer has been redirected to paysafecard s payment panel to authorize the payment. The customer has authorized the payment. The payment has been completed successfully. You, as the business partner, have cancelled the payment. The customer has cancelled the payment on the payment panel The customer has not authorized the payment during the disposition time window OR you, the business partner, have not captured the authorized amount during the disposition time window Column(s) online display filter Due to the number of columns available to you and a display design issue, we provide you with a solution which allows you to add and delete the columns you want to see in the online results. Please note this does not apply to the downloaded csv output file. By default, the columns below are pre-defined. 8

9 Reset Filter By clicking the Reset filter button your selection will be cleared allowing you to redefine your next search. b) Online results Once you have defined your search criteria, to view the results online you click Generate report button The following parameters are visible in the online results: MID, Transaction ID, MCID, RC, RC name, Initial Amount (Transaction Currency), Disposition Amount (Transaction Currency), Debited Amount (Transaction Currency), Disp. State, Status Before Expiration, Dispo. Date, Dispo. Assign Card Date, Date of last possible debit, Card Type, Details, Surcharge MTID Transaction Parameter glossary RowNr The RowNr is a sequential number for each displayed transaction. Transaction ID (TID) The Transaction ID (TID) is (concerning a certain Merchant ID) a unique alphanumeric identification of individual payment transactions. It is the responsibility of the merchant to provide the unique merchant transaction ID (TID) and remember it for future reference. MerchantClientID Is a unique end customer identifier with a max. length of 50 characters (the unique ID of the end customer as registered in your database). NOTE: for security reasons do not use the customer s registered username or . Reporting Criteria [optional] The Reporting Criteria offers the possibility to classify transactions, which allows to differentiate transactions between several web shops of one contracting party. Agreement with paysafecard is needed for setup of this Reporting Criteria. The reporting criteria must be registered by paysafecard in the system and enabled to be used thereafter. Otherwise this parameter is empty. 9

10 RC Name This is the name associated to the pre-defined Reporting Criteria ID. Initial Amount (Transaction Currency) Under Initial Amount (Transaction Currency) that amount is aforementioned with creating a disposition (by the function call createdisposition ). Disposition Amount (Transaction Currency) The Disposition Amount (Transaction Currency) is the amount, that is currently reserved for the merchant. The customer has successfully paid, but the merchant has not yet debited the amount. This amount has to be debited (by the function call executedebit ) within the agreed disposition time. Otherwise, this amount will be lost for the merchant and given back to the customer s paysafecard. Debited Amount (Transaction Currency) The Debited Amount (Transaction Currency) is the amount, that is currently withdrawn (debited by the function call executedebit ) for the merchant. The customer has successfully paid, and the merchant has successfully debited the amount. This amount will be settled to the merchant s bank account with the following settlement report. Disp. State Dispositions also have a state which changes during the payment life cycle. possible expiration process: status R X status R S then X (after disposition timeout) Disp. Date The disposition date is the date when it was created (by the function call createdisposition ). Dispo. Assign Card Date The Assign Card Date shows the timestamp, where at least one paysafecard has been assigned to the disposition. This date is also the start of the disposition time window1, which has a default value of 1 hour. The merchant has to finish the disposition before that time window expires. Date of last possible debit The Date of last possible debit is the end of the agreed disposition time. Up to then a capture (by the function call executedebit ) is still possible, later the transaction will be closed and set to state X (EXPIRED). Card Type This shows which card type was used in the transaction. Three possible parameters are listed: PAYSAFECARD for transactions that are paid by classic paysafecard PINs INHOUSE for transactions that are paid with so called in-house cards (promotion cards). In-house cards are activated for the merchant upon its request and needs a separate contract with paysafecard MIXED for transactions that are paid with classic paysafecard PINs and in-house cards together. 10

11 c) Details button On a transaction level you can view further details on the transaction. By clicking the Details button you are redirected to the detail overview of the Payment Transaction. Then following details screen is displayed: To go back to the results page please click Back to report 11

12 Payment Detail glossary Merchant ID (MID) This is the unique alphanumeric identification of the merchant/by default 10-digit long Merchant ID. Transaction ID (TID) This is the unique identifier for each disposition. Reporting Criterion The Reporting Criterion is a optional parameter that offers the possibility to classify transactions. MerchantClientID This is a unique end customer identifier with a max. length of 50 characters (the unique ID of the end customer as registered in your database). NOTE: for security reasons do not use the customer s registered username or . Client IP This is the IP address of the customer. Merchant IP This is the IP address of the merchant s payment server. Client Country based on IP This is the country based on customer s IP address. Client City based on IP This is the city based on the customer s IP address. Client Country used on payment panel This country code is based on the payment panel choice by the customer. This may differ from the client country based on IP, only if the customer manually changed the country in the drop down menu. Client language This is the language of the customer, based on the IP address. RowNr The RowNr is a sequential number for each displayed card transaction. Debit Number The Debit Number serves the clear marking of a partial capture (debit) within one disposition; set per default as number 1. Debit Amount in Transaction Currency The Debited Amount in Transaction Currency is the amount, that is currently withdrawn (debited, execute_debit). Debit Date The debit date is the date when the transaction was debited (by function call execute_debit). 12

13 Card dispositions details: RowNr The RowNr is a sequential number for each displayed card transaction. Serial number 16-digit numeric code of the card used in the transaction. Rank The Rank is a sequential number for each used paysafecard. State The current state of the transaction. Initial Amount in Card Currency Shows the initial created amount in card currency. Disposition Amount in Card Currency Shows the disposition amount in card currency, this is the reserved amount. Hist. Amount in Card Currency Shows the historical amount in card currency. Exchange Rate of Card Currency to EUR If the merchant currency and card currency are not equal, the exchange rate will be displayed here. Initial Amount in Transaction Currency Shows the initial created amount in transaction currency. Disposition Amount in Transaction Currency Shows the disposition amount in transaction currency, this is the reserved amount. Hist. Amount in Transaction Currency Shows the historical amount in transaction currency. Exchange Rate of Transaction Currency to EUR If the merchant currency and card currency are not equal, the exchange rate will be displayed here. Card Type Shows the kind of card, which was used in the transaction. Three possible parameters are listed: PAYSAFECARD for transactions that are paid by classic paysafecard PINs INHOUSE for transactions that are paid with so called in-house cards (promotion cards). In-house cards are activated for the merchant upon its request and needs a separate contract with paysafecard. MIXED for transactions that are paid with classic paysafecard PINs and in-house cards together 13

14 d) Download Report To download your report after you have defined valid search criteria, please click Download Report. The list also can be downloaded as a text-file in the CSV-Format (CSV = Comma Separated Values) by choosing the button Download Report : SAMPLE , DL , 1,, EUR, 1.00, 5.00, 20.00, 0.94, 1.00, , , :26: , 1.00, 0.00, :13: , MT, RD , DL , 1,, EUR, 1.00, 5.00, 20.00, 0.94, 1.00, , , :07: , 1.00, 0.00, :06: , MT, RD , DL , 1,, EUR, 1.00, 5.00, 20.00, 0.94, 1.00, , , :00: , 1.00, 0.00, :59: , MT, RD Following parameters are shown per row: (in CSV-file): MID, Transaction ID, MCID, RC, RC name, Initial Amount (Transaction Currency), Disposition Amount (Transaction Currency), Debited Amount (Transaction Currency), Disp. State, Status Before Expiration, Dispo. Date, Dispo. Assign Card Date, Date of last possible debit, Kind of card, QR Code Payment, Surcharge MTID 14

15 5) Settlement Report View all of your settled transactions from the Settlement Report of Merchant Service Center. NOTE THE FOLLOWING CONSTRAINTS: Date from and Date to are mandatory, except when searching for a specific Invoice number Download report csv limitation of 200,000 rows Online results are limited to 1500 rows. If there are more based on your search criteria you will get an info message asking you to download for the full view. Maximum search date range is 1 year 15

16 a) Search filters for the Settlement Report Merchant IDs When you have more than 1 MID assigned to your account you can search for multiple MID s. To build your list of MID s please select them one by one. If one has been selected from the drop down list, it will appear dark grey in color as shown below. By default, all are selected as shown below Date filter 16

17 The date selection is in the form of a date picker or you can manually enter in the date dd/mm/yyyy. By default, the Time field is (Date from) from = 00:00 and (Date to) until = 23:59, however you can manually define the time range of your search. NOTE: maximum allowed search: 12 months at once Reporting criteria ID If reporting criteria has been configured for your Merchant account, then it will appear here automatically for selection. You can define 1 or more Reporting criteria ID(s) however as with the Merchant ID the default is to show all. Or default is as shown below Merchant Client ID: Now you can search on the Merchant Client ID to help target your search to individual customer accounts of your company. The field is a free text input field. 17

18 Invoice Number User can input a particular invoice number here to target all relative settlement transactions. This is a free text input field. Column(s) filter Due to the number of columns available to you and a display design issue, we provide you with a solution which allows you to add and delete the columns you want to see in the online results. Please note this does not apply to the downloaded csv output file. By default, the columns below are pre-defined. Reset Filter By clicking the Reset Filter button your selection will be cleared allowing you to redefine your next search. 18

19 b) Online results Once you have defined your search criteria, to view the results online you click Generate Report button The following parameters are visible in the online results: MID, TransactionID, DebitNr, ReportingCriteria, MerchantClientID, GrossAmount, PercentageOfCommission, PercentageOfTax, DebitAmount, ExchangeRate, InvoiceNumber, VoucherNumber, DebitTimestamp, InitialAmount, DispositionAmount, NetAmount, CreationTimestamp, ShopId, ClientIpCountry, CardOrigin Settlement Parameter glossary Merchant Id (MID) This is a unique alphanumeric identification of the merchant/by default 10-digit long Merchant ID. Merchant Transaction Id (MTID) This is the unique identifier for each disposition. Debit Number The Debit Number serves the clear marking of a partial capture (debit) within one disposition. Reporting Criteria The Reporting Criteria offers the possibility to classify transactions, which allows to differentiate transactions between several web shops of one contracting party. Agreement with paysafecard is needed for setup of this Reporting Criteria. The reporting criteria must be registered by paysafecard in the system and enabled to be used thereafter. Otherwise this parameter is empty. MerchantClientID Is a unique end customer identifier with a max. length of 50 characters (the unique ID of the end customer as registered in your database). NOTE: for security reasons do not use the customer s registered username or . Gross Amount The Gross Amount is displayed at the monthly invoice. Percentage of Commission The Percentage of Commission is the margin in percentage (%), that is agreed in the contract. Tax The Sales Tax is set in percentage (%). Debit Amount The Debit Amount is that amount, that was debited from the customer s paysafecard (via function call execute_debit). 19

20 Exchange Rate If the merchant currency and card currency are not equal, the exchange rate will be displayed here. Invoice Number The Invoice number is the 10-digit number of the invoice. Voucher Number The Voucher Number is the number, that is given to all transactions of one day. Debit Timestamp The Debit Timestamp is the time when the disposition was debited (via function call execute_debit). Initial Amount The Initial Amount is the amount, that was created (via function call create disposition). Disposition Amount The Disposition Amount shows the current disposed amount, that is not yet debited. Net Amount The Net Amount is the Gross Amount minus the commission and percentage of tax: Gross Amount (1 + VAT [%] / 100) * Gross Amount * Percentage of Commission [%] / 100. Creation Timestamp Disposition The Creation Timestamp Disposition is the time when the disposition was created (via function call create_ disposition). ShopID Identification of the shop which is the originator of the request. This is most likely used by payment service providers. (optional) who act as a proxy for other payment methods as well. Country IP The 2 digit ISO country code, where the PIN was used, please note that this information is derived from our systems and although carefully provided we do not assume any liability on the correctness of the data shared for country. Card origin The 2 digit ISO country code, where the PIN was sold. 20

21 c) Download report To download your report after you have defined valid search criteria, please click Download Report The list also can be downloaded as a text-file in the CSV-Format (CSV = Comma Separated Values) by choosing the button Download Report : SAMPLE , DL , 1,, EUR, 1.00, 5.00, 20.00, 0.94, 1.00, , , :26: , 1.00, 0.00, :13: , MT, RD , DL , 1,, EUR, 1.00, 5.00, 20.00, 0.94, 1.00, , , :07: , 1.00, 0.00, :06: , MT, RD , DL , 1,, EUR, 1.00, 5.00, 20.00, 0.94, 1.00, , , :00: , 1.00, 0.00, :59: , MT, RD Following parameters are shown per row: (in CSV-file): MID, TransactionID, DebitNr, ReportingCriteria, MerchantClientID, GrossAmount, PercentageOfCommission, PercentageOfTax, DebitAmount, ExchangeRate, InvoiceNumber, VoucherNumber, DebitTimestamp, InitialAmount, DispositionAmount, NetAmount, CreationTimestamp, ShopId, ClientIpCountry, CardOrigin 21