SFTP File Submission

Initiating payments via batch file sent over SFTP

See instructions here for file formats, responses, etc

Connection and Authentication

SFTP Batch File Initiation is enabled on a case by case basis. Contact the TodayPay team to enable SFTP upload for your merchant account. Each environment requires it's own API credential pair.

Sandbox SFTP Host name: gateway-sandbox.todaypay.me

Production SFTP Host name: TodayPay team will provide

Username: API Primary Key Credential (pk_...)

Password: API Private Key Credential

File Paths

Upload Submission Files to the root directory. Acknowledgement File and Response File will be returned alongside the Submission File in the same root directory.

File Naming

Ensure each Submission File name must be globally unique.

Submission Files can be named at your discretion, but each Submission File name must be globally unique with .csv extension. Acknowledgement File and Response File are returned with the following naming convention:

Acknowledgement File: ack_<submission_file_name>.csv

• Returned for every Submission file uploaded

• E.g. Uploaded Submission File abc.csv will return ack_abc.csv

Response File: processed_<submission_file_name>.csv

• Only returned if file is accepted and Acknowledgement File status = ACCEPTED

• E.g. Uploaded Submission File abc.csv will return processed_abc.csv if submission is successful

Duplicate File Names

This is a unique failure case in which SFTP upload will succeed and the original file will be replaced, but processing will not occur. No Acknowledgement File will be generated.

Submission Files with previously-used names will not be processed. Every Submission File should be uniquely named (e.g. via UUID or timestamp).

Deleting Files

Files on the SFTP server can't be deleted.