Skip to main content

File Access and Permissions

This section describes how to access settlement data.

Payen provides two methods to access settlement files.

  1. The first is via Vision, using the Export Reports portal.
  2. The second is an SFTP solution to download the files programmatically.

Exporting from Vision​

The Export Reports portal allows users to run reports from a preset list. Each report has its own search parameters, specific to the report selected. It can be found in Vision under Reports → Export Reports as shown in Export Reports Menu Item](#export-reports-menu-item)

info

Access to this page will need to be granted to the user. Further details in the Access Controls section


Export Reports Menu Item


Payen provide two sets of settlement reports for download. Settlement Reports and Monthly Settlement Reports. Details of the reports provided can be found in the Settlement Files section.

Settlement Reports​

These reports align with the merchant's settlement period and are dated with the settlement date that money is paid. They show any settlement activity for that settlement period.

To run this report:

  1. Select "Settlement Report" from the "Report Type" menu.
  2. Enter a name for the report. (This is optional and a unique name will be generated if left blank)
  3. Select the "From" and "To" dates to indicate which settlement dates to search for. (This is limited to a maximum range of 1 month at a time. If you need more than 1 month's worth of files, separate requests will need to be made)
  4. Select one or more "Settlement Merchant" values to search for. (This is optional and will default to find all settlement merchants the user has access to)
  5. Click "Schedule". A report request will appear in the table, which will update when it's complete, giving an option to download a zip file containing all the files found.

Monthly Settlement Reports​

These reports align with each calendar month and are dated with the last day of the month. They show any settlement activity for that calendar month.

To run this report:

  1. Select "Monthly Settlement Report" from the "Report Type" menu.
  2. Enter a name for the report. (This is optional and a unique name will be generated if left blank)
  3. Select the "From" and "To" dates to indicate which settlement dates to search for. (This is limited to a maximum range of 6 months at a time. If you need more than 6 month's worth of files, separate requests will need to be made)
  4. Select one or more "Settlement Merchant" values to search for. (This is optional and will default to find all settlement merchants the user has access to)
  5. Click "Schedule". A report request will appear in the table, which will update when it's complete, giving an option to download a zip file containing all the files found.
info

Access to "Settlement Merchants" is driven by the users account access. Further details in the Access Controls section

Access Controls​

info

Access to Vision is managed by your Merchant Administrator, a user with authority to allocate permissions to people in your organisation. If you are unable access Export Reports, please speak to your administrator.

To access the settlement reports through Vision the user needs the the following permissions

  • "Generate Reports" - Grants access to the Export Reports page.
  • "Export Settlement Reports" - Grants permission to download settlement reports.

SFTP​

As part of the merchant on-boarding process a dedicated SFTP user will be setup. The servicing team can provide details of this account and login details on request. All reports generated will be put into a single directory called "platform_files/out". This will contain the last 10 days worth of files, after which they'll be removed from the directory. Older files can be downloaded from Vision.