Skip to main content

Advanced Batch Upload | SFTP

Updated

Table of Contents

Overview

We support SFTP uploads, enabling merchants to seamlessly automate their Batch Upload and Response Download processes. This system allows for full application integration, eliminating the need for manual intervention and ensuring a smooth, efficient workflow.

Prerequisites

The user will need 'Batch Access' and 'Access FTP' permissions.

How to Upload via SFTP

1. Install SFTP Software

  • Download and install an SFTP client such as WinSCP. Run the .exe file and follow the installation prompts.

2. Set Up the Connection

  1. Open WinSCP and click New Tab.
  2. In the Site Manager, enter the following details:
  • File Protocol: SFTP
  • Host Name/IP:  batch-ftp.safewebservices.com
  • Port Number: 2222
  • Username/Password: Merchant gateway account credentials.

     3. Click Login. If successful, a script will run confirming the connection.

3. Upload Files
The right panel shows the server (remote) files. The left panel represents your local storage (computer, USB, etc.).

  1. Navigate to the /upload folder on the server (right panel).
  2. Locate your file(s) on the left panel and drag them into the /upload folder on the right panel.

4. File Processing & Response Files

  • Files are processed every 5-10 minutes, but timing may vary based on the processor. The file name doesn’t matter—responses will be delivered to the /response directory.
      • Example: If you upload transactions.csv to /upload, the response file will be saved as /response/response-transactions.csv.
  • To view the response file navigate to the /response folder in WinSCP and download the file. Alternatively, check batch history in the Merchant Control Panel → Batch Upload → View Batch History.

Sample CSV/TXT File

Here’s an example file that will process 5 sale transactions, and includes the customer name, and address data. Please review our Getting Started | Batch Upload article for further instructions and requirements.

"sale","4111111111111111","1029","39.99","Dolores","Howe","123 Fake St.","Tucson","AZ","12345"
"sale","4111111111111111","1028","59.99","Richard","Quitzon","123 Fake St.","Tucson","AZ","12345"
"sale","4111111111111111","1128","65.99","Nettie","Green","123 Fake St.","Tucson","AZ","12345"
"sale","4111111111111111","1229","79.99","Frankie","Rath","123 Fake St.","Tucson","AZ","12345"
"sale","4111111111111111","1030","89.99","Rex","Wyman","123 Fake St.","Tucson","AZ","12345"

Frequently Asked Questions

Does Webhooks work with batch uploads through the SFTP? Yes, this is supported. Once the batch upload transactions start running they will start sending out the webhook notifications as they complete.

What file formats are supported? We support CSV, XLS, and TXT.

How can I check the status of my batch upload? You can check the status of your batch in the Merchant Control Panel by navigating to Batch Upload → View Batch History or by retrieving the response file from the /response folder in WinSCP.

Where do I retrieve response files after upload? Response files are saved in the /response directory. You can access them using your SFTP client or check batch results in the Merchant Control Panel.

Can I use a different SFTP client other than WinSCP? Yes, any SFTP client (such as FileZilla, Cyberduck, or command-line tools) can be used as long as it supports SFTP connections.