Skip to main content

SFTP setup

Reseller clients, marketplaces and enterprises can opt to receive their standard reports via SFTP.

note

The data provided in the Transaction and funding reports is also available via API (see the Retrieve payments section of our API documentation under Get all transactions and Get transaction by ID for more details). If you are only receiving reporting data via API, the following documentation on SFTP will not be applicable to your solution.

To set up your reporting folder directory, all that is required is as follows:

  1. For enterprise and marketplaces: your uP Account ID / for reseller clients: your uP Partner ID (these IDs are assigned during onboarding),
  2. An SFTP client (Filezilla, for example),
  3. Your SSH public/private keys, (Not sure how to generate your SSH public/private keys? The team over at Acquia has provided some easy-to-use instructions here), and
  4. Your public IP address (NomuPay will need to whitelist this as part of the setup process)

Once you've generated your SSH keys, please take a moment to send the public key and your public IP address to your NomuPay representative. Our team will use this key to create your SFTP connection. Once your connection has been established (we will confirm this with you via email) you will be able to log in using your SFTP client using your uP Account ID (ex. EID-1234567) if you are an enterprise or marketplace, or, if you're a reseller client, your uP Partner ID (ex. PID-1234567), as your username. Your password will be your private key and must be used with the "Key File" Logon type. For more information on this Logon Type, please review this helpful article from Filezilla.

Once connected, you will see the following directory: uP-Payments. Within the directory you will see the following subdirectories:

  • Reports (this is where NomuPay will load "Report" files)
    • Transaction-Report
      • Archive
    • Funding-Report
      • Archive
    • Rev-Sharebuy-Rate (this will only be visible to reseller clients)
      • Archive

You can choose to automate the extraction of the .csv files, by applying a script. For your convenience, please find a simple example below, which can serve as a base for you to script the extraction of data from Transaction Reports:

#!/bin/bash
cd transaction-report/
FILES="daily_transaction_report_*.csv"
for f in $FILES
do
  parse(f) #up to you to choose what you want to extract from the file during parsing
  mv -f "$f" /archive  #processed files are moved to archive
done

The same principle can be applied for the funding Reports:

#!/bin/bash
cd funding-report/
FILES="daily_funding_report_*.csv"
for f in $FILES
do
  parse(f) #up to you to choose what you want to extract from the file during parsing
  mv -f "$f" /archive  #processed files are moved to archive
done

Note the above examples suggest moving processed files into an archive, however, what you do with these files is up to you. You can either:

  • Move processed files to archive or,

  • Keep the files in their original location and process the files based on the reporting timestamp (all reports have the file name format of daily_funding_report_<AccountID>_<yyyymmddhhmmss>.csv – making it easy for your team to process them based on the _<yyyymmddhhmmss> portion of the file name).

Please note that all files are currently kept indefinitely on the SFTP.