Reporting
      Back to home
      1. Helpdesk
      2. Payment Management
      3. Reporting

      Reporting

      Steps to develop reports and participate in a range of report-related activities.

      Add new Charge Reports

      To request a new Charge report:

      1. Go to Charges > View Mode.
      2. Choose a ready template from the arrow next to Settings in the upper right corner. Or add a new template here .
      3. Click Download Report > Request report from the drop-down menu.
      4. The Report Delivery tab will be opened. Fill in the report settings:
        1. Label - the report's name.
        2. File Name Pattern - the type of the pattern for file naming.
        3. Destination - the report's receiving channel (email or SFTP). Insert the email address or choose the SFTP destination from the drop-down menu.
        4. Processing Type - encrypted or non-encrypted file. If you'd like to encrypt the file, you can choose your encryption service from the drop-down menu.
        5. Report Type - the types of the reports: One-Time or Recurring. If Recurring choose Interval and Frequency.
        6. Start Date - the report's start date.
      5. Press Save.

      To add a new SFTP service, go here. To add Encryption service, go here .

      Note : Paydock's dashboard has a constraint on report generation, allowing for a maximum of 20 reports to be generated simultaneously. This limitation is applicable across all companies, brands, and at a global level.

      Edit Charge reports

      To edit a recurring Charge report:

      1. Go to Charges> Report History > Actions > Edit report for the specified recurring report.
      2. Click Update.

       

      Remove Charge Reports

      To remove a Charge report:

      1. Go to Charges > Report History > Actions > Remove for the specified report.
      2. Click Confirm.

       

      View Charge Reports details

      To view a Charge report's details:

      1. Go to Charges > Report History > Actions > View Details for the specified report.

      Here are the Report's Details:

      • Report ID - the requested report's ID.
      • Status - the requested report's status (Completed, Active, Cancelled Manually).
      • Report Details - the requested report's settings.
      • Report Statistics - the number of generated reports.
      • Applied Filters - the requested report's filters (Archived, Labels, Select, VIew_mode).

      To view the access logs of the generated reports:

      1. Generated Reports > Actions > Access Logs for the specified report. You can use the filter option or browse the list.

      Here are the Access Logs' details:

      • Type - the type of access (Endpoint response, File server).
      • Initiatory User Details - the report requestor's details (User ID, Email, Full Name).
      • Link expires at - the report link's expiration time and date in UTC.
      • Link created at - the report link's creation time and date in UTC.

      Download Reports from Charges

      To download relevant Transaction data in CSV format:

      1. Go to Charges > View Mode > Download Report > All Filtered Items or Just This Page.

      Download either a single page with 10, 25, 50 or 100 rows or all filtered items based on one or more of the criteria below:

      • First and Last Name
      • Email, Reference
      • External ID
      • Charge ID
      • Date range
      • Payment Service
      • Vault Token
      • Transaction Type
      • Status
      • Amount
      • Last 4 digits of the card
      • Customer ID
      • Subscription ID

      Note: For reconciliation discrepancy, Paydock uses ISO 4217 standards to truncate transactions in all currencies to 2 digits after the decimal, without any rounding, e.g.30.895 is truncated by us to 30.89.

      Note: If the Download buttons are not working, allow pop-ups for Paydock's URL (https://app-sandbox.paydock.com/ or https://app.paydock.com/ ) in the browser. 

       

      Download Customer Reports

      To download relevant Transaction data in a CSV format:

      1. Go to Customers > History > click on All Filtered Items or Just This Page.

      Download either a single page with 10, 25, 50 or 100 rows or all filtered items based on one or more of the criteria below (including a full match of the filtered information):

      • Name
      • Full email 
      • Reference 
      • Company Name 
      • Payment Service 

      Note: Reconciliation discrepancy Paydock uses ISO 4217 standards to truncate transactions in all currencies to 2 digits after the decimal, without any rounding, e.g.30.895 is truncated by us to 30.89.

      Note: If the Download buttons are not working, allow pop-ups for Paydock's URL (https://app-sandbox.paydock.com/ or https://app.paydock.com/ ) in the browser. 

       

      Download Subscriptions Reports

      To download relevant Transaction data in CSV format:

      1. Go to Subscription> View All > click on All Filtered Items or Just This Page.

      Download either a single page with 10, 25, 50 or 100 rows or all filtered items, based on one or more of the criteria below:

      • Customer Name
      • Subscription ID
      • Customer ID
      • Payment Service

      Note: For Reconciliation discrepancy, Paydock uses ISO 4217 standards to truncate transactions in all currencies to 2 digits after the decimal, without any rounding, e.g.30.895 is truncated by us to 30.89.

      Note: If the Download buttons are not working, allow pop-ups for Paydock's URL (https://app-sandbox.paydock.com/ or https://app.paydock.com/ ) in the browser. 

      Download Notifications Reports

      To download relevant Transaction data in a CSV format:

      1. Go to Notifications > History > Download Selection.

      Download either a single page with 10, 25, 50 or 100 rows or all filtered items based on one or more of the criteria below:

      • Date Range
      • Event
      • Type
      • Status 
      • Parent ID
      • Relation ID (e.g. Subscription ID, Charge ID or Transaction ID)

      Note: If the Download buttons are not working, allow pop-ups for Paydock's URL (https://app-sandbox.paydock.com/ or https://app.paydock.com/ ) in the browser. 

       

      Download Vault Reports

      To download relevant Transaction data in a CSV format:

      1. Go to Vault > All Filtered Items or Just This Page.

      Download either a single page with 10, 25, 50 or 100 rows or all filtered items based on one or more of the criteria below:

      • Email
      • Card Name
      • Account Name
      • Last 4 digits of the credit card
      • Payment Source Type
      • Expiry month and year

      Note: If the Download buttons are not working, allow pop-ups for Paydock's URL (https://app-sandbox.paydock.com/ or https://app.paydock.com/ ) in the browser. 

       

      Download Transfers Reports

      To download relevant Transaction data in CSV format:

      1. Go to Transfers > Transfers > click on All Filtered Items or Just This Page.

      Download a single page with 10, 25, 50 or 100 rows or all filtered items based on the criteria Description.

      Note: If the Download buttons are not working, allow pop-ups for Paydock's URL (https://app-sandbox.paydock.com/ or https://app.paydock.com/ ) in the browser. 

       

       

       

      Reporting Encryption

      Reporting Encryption feature enables Merchants to use PGP keys for encrypting report files which are generated by the Paydock reporting engine and delivered via various channels, namely, SFTP, email, and link.

      As an encryption algorithm, PGP has been chosen as a standard for email security. Pretty Good Privacy (PGP) is an encryption system for sending encrypted emails and encrypting sensitive files.

      PGP uses both symmetric encryption and public-key encryption, it allows users who have never met to send encrypted messages to each other without exchanging private encryption keys.

      How to set up a PGP key:

      1. Generate PGP public and private keys with a tool similar to PGP Tool - Online PGP Key Generator Encryption Decryption Tool
      2. Go to Paydock Dashboard → Services → Add New page
      3. Select Encryption Services from the Service Group dropdown.
      4. Click Activate next to the PGP service.
      5. Fill in the following details:
        1. Label - a custom name for your PGP service
        2. Public key - the generated public key
        3. Go to Charges and proceed with the report setup as described here.
        4. Click Download Report > Request report from the drop-down menu.
        5. Fill in the report settings and for
        6. Processing Type - choose Encrypted from the dropdown
        7. and the Encryption service label from the new dropdown.
      6. Press Confirm.
      7. Receive an encrypted report file to the chosen destination and download it.
      8. Decrypt the report, for example, with this tool https://pgptool.org/ → 'Decrypt (+Verify)' option using the private key.

       

      Generate & Deactivate Link Charge Reports

      To generate a report link: 

      1. Go to Charges > Reports > Generated Reports > Actions > Copy link to report for the specified report. You can use the filter option or browse the list.
      2. Insert the hours for the link's lifetime.
      3. Click Generate a link.
      4. Copy and share the link, as it will not be available in the dashboard afterwards.

      To temporarily deactivate the report's generated link:

      1. Go to Charges > Reports > Generated Reports > Actions > Deactivate link for the specified report. You can use the filter option or browse the list.
      2. Press Confirm.

       

      Generate & Deactivate Link Charge Reports

      To generate a report link: 

      1. Go to Charges > Reports > Generated Reports > Actions > Copy link to report for the specified report. You can use the filter option or browse the list.
      2. Insert the hours for the link's lifetime.
      3. Click Generate a link.
      4. Copy and share the link, as it will not be available in the dashboard afterwards.

      To temporarily deactivate the report's generated link:

      1. Go to Charges > Reports > Generated Reports > Actions > Deactivate link for the specified report. You can use the filter option or browse the list.
      2. Press Confirm.