Transaction Reports

You can generate a transaction report in two ways: through the PaymentsOS Control Center, or using the Reporting API. The PaymentsOS Control Center, provides an intuitive user interface for defining a report, creating report templates and configuring reporting schedules. The Reporting API in contrast, allows you to extract the report data programmatically. This gives you some flexibility not available when creating a report through the Control Center UI. For instance, you can use the API to create more advanced filter criteria to increase the granularity of the data extracted to a report.

Report Generation and Delivery Time

When scheduling a report, it will always be generated at 01:00 AM in the timezone you specified.

Scheduled Reports File Names

Scheduled reports will have the following file names when generated:

• Archive name: {year-month-day}_sch_{daily/weekly/monthly}_{report template name}

• File name: sch_{daily/weekly/monthly}_{report template name}

Storing Reports on the PaymentsOS SFTP Server

By default, generated reports are sent to your email address. If desired, you can also store the reports you generate in a folder on our SFTP server. Two caveats:

• Reports remain stored on our SFTP server for a period of 14 days, after which they are deleted. If you need access to a report after it’s been removed, you can always generate the report again on-the-fly.

• Scheduled reports can be delivered either to an SFTP folder or to your email address, not both. So if you choose to have your scheduled reports delivered to a folder on our SFTP server, they will no longer by sent to your email address.

Generating SFTP Credentials

Before you can set the SFTP server as your preferred delivery option, you must first generate your SFTP credentials. You can easily do so from the PaymentsOS Control Center, but hold your horses for just a bit longer! Access to the SFTP server uses SSH key authentication, so you will first need to create an SSH public and private key pair. The public key will be uploaded to our server (you will need to provide it when generating the SFTP credentials); the private key remains with you and will allow your SFTP user to authenticate when connecting to the PaymentsOS SFTP server. There are several utilities out there for generating SSH key pairs, so just choose one to generate the keys.

With the SSH public key at hand, head over to the PaymentsOS Control Center and choose Account > SFTP Management > Generate new SFTP credentials. You can then enter the SSH public key you generated earlier, and choose a folder on the SFTP server in which to store the reports. Notice that you do not choose a user name yourself. That is because we will create a user for you, with a randomly generated user name. Once you generated the SFTP credentials, you can use them in an SFTP client to connect to the PaymentsOS SFTP server. Aside from the credentials, you will need the SFTP server address and port:

• Address: sftp.paymentsos.com

• Port: 22

Enabling SFTP Delivery for Scheduled Reports

Once you generated your SFTP credentials, you can set the SFTP delivery option as your delivery option of choice. All you need to do is to toggle on the SFTP Delivery option when scheduling a report and choose the folder on the SFTP server in which the report will be stored.