Setup Reports SFTP

Overview

As a Branch partner, you can access transaction data from PayAdmin. To help automate your integration, SFTP enables Branch to push standard or custom reports securely to a Branch-hosted shared directory accessible by your Organization.

Credentials

Working with your Branch team, generate a key pair and send Branch the public SSH key.

Your Branch team will set up the connection and send you details similar to the following:

Host: ftp.branchmessenger.io

Port: 22

User: [orgkey]

Directories: 

/in - Inbound files sent to Branch. Branch will pull from this directory.

/out - Outbound files sent from Branch. Branch will push to this directory. 

Auth: Authenticated by public key provided.

These represent the credentials necessary to access the directory using SFTP.

Usage

Use the credentials as arguments to sftp shown below using the command line. These credentials can also be used with GUI SFTP programs, or for accessing SFTP directory contents programmatically with custom server code.

sftp -i /path/to/private/key [orgkey]@ftp.branchmessenger.io