Settlement Reports

Enabling the Settlement Report Generation Option

Before you can generate settlement reports, we must enable this option for your PaymentsOS account. Contact your account manager to enable the settlement report option for your account.

Generating the Settlement Report

You can generate a settlement 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.

Settlement Report Columns

Regardless of how you choose to generate the settlement report (through the PaymentsOS Control Center or using the Reporting API), you will have to let us know what data you want to include in the report. You do so, by providing the names of the columns holding the data to be exported. There’s a lot to choose from and not all column names are self-explanatory, so we listed the columns for you in the table below.

Report Generation and Delivery Time

Currently, you can only generate a settlement report for transactions processed through PayU India and PayU Latam. For PayU India, the settlement data will always be available at 22:30 UTC for settlement data of the current day. For PayU Latam, the settlement data will always be available at 10:00 AM UTC for settlement data of the previous day.

When scheduling a report, it will always be generated at 01:00 AM in the timezone you specified, regardless of the provider (PayU India or PayU Latam) that processed the transactions.

Settlement Reports Timezone

When generating a settlement report, you have the option of specifying a timezone. PaymentsOS will use this timezone to convert the timestamps in the report to the timezone you select. Beware that the timezone you specify does not affect the data range: it only changes the date displayed in the report to reflect the specified timezone. This applies both to the timezone you specify in the Reporting API (where the field you pass is appropriately called display_timezone) and the timezone you select when generating a report through the PaymentsOS Control Center.

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.

Considerations

When generating a settlement report, take the following into account:

• Currently, you can only generate a settlement report for transactions processed through PayU India and PayU Latam.

• In settlement reports generated for transactions processed with PayU Latam, we include all transactions from the previous payout to the current payout and assign the reference of the latest payout to the individual transactions as a representation of the payout batch. The batch number is available in the Settlement Batch Reference column in the generated settlement report.

• Depending on your integration logic, there may be transactions that are processed directly with a specific provider without being routed through PaymentsOS. Note, however, that some fields in the report are populated with data from transactions that are handled through PaymentsOS. If a transaction was handled directly by the provider, then those fields will be empty. If this is the case, it is mentioned specifically in the description of the field listed in the fields overview table above.

• Operations such as chargebacks, chargeback reversals and payouts are initiated by the provider and not by PaymentsOS. This means that transactions related to these operations will appear in the settlement report, you will not be able to find chargebacks when searching PaymentsOS or when generating transaction reports.