The Secure File Transfer Protocol (SFTP) is a protocol used to securely access, transfer and manage files over a network. This protocol uses Secure Shell (SSH2) to encrypt content, ensuring the transferred data is unreadable, and providing data confidentiality during file transfers, access and deletion. SFTP is a key component of your integration, as Solaris uses this to send partners important information both during the onboarding process and during the lifecycle of your integration, including:
- Transactional reports
- Statements of fees
- Bulk payment files
- API configuration details and access keys (sent during the onboarding process).
Both your production and sandbox integrations require their own dedicated SFTP account.
As part of the API integration process, Solaris will set up a dedicated partner SFTP account. Each environment (both sandbox and production) requires its own SFTP account. When requested, the following must be provided to Solaris by you to complete this setup:
- Public IP address (for whitelisting)
- SSH Public Key (for SFTP access)
The SFTP URLs for each environment are as below, both use port 22:
In order to generate an SSH public key, use the appropriate steps outlined below:
- Download Putty Key Generator.
- Select RSA.
- Enter the number of bits (copy the shown value).
- Click Generate and move your mouse in the upper blank area as instructed - this mouse movement provides randomness for the key generation process. From this, PuTTY key generates a keypair.
- Type a comment in the Key comment field (for example "Solaris SFTP").
- Enter a strong 16-character passphrase that includes upper and lowercase letters, numbers, and symbols.
- Confirm the passphrase.
Save Private Key
to save your private key with a
- Click Save Public Key to save your public key without any extension.
- Save and Share the attachment of SSH public key with the Solaris networking team.
- Now view the Testing your SFTP connection section.
To ceate a new SSH key with the label "Solaris SFTP", open a terminal and paste the following:
ssh-keygen -t rsa -b 2048 -C "Solaris SFTP"
When you’re prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location.
Enter a file in which to save the key (/Users/you/.ssh/id_rsa) : [Press enter]
At the prompt, type a secure passphrase. Choose a strong 16-character passphrase that includes upper and lowercase letters, numbers, and symbols.
Enter same passphrase again: [Type passphrase again]
Add your SSH key to the ssh-agent.
Start the agent in the background.
eval "$(ssh-agent -s)"
Agent pid 59566
If you’re using macOS Sierra 10.12.2 or later, you will need to modify your
~/.ssh/config file to automatically load keys into the ssh-agent and store passphrases in your keychain.
1. Host *
2. AddKeysToAgent yes
3. UseKeychain yes
4. IdentityFile ~/.ssh/id_rsa
Add your SSH private key to the ssh-agent and store your passphrase in the keychain. If you created your key with a different name, or if you are adding an existing key that has a different name, replace
id_rsa in the command with the name of your private key file.
ssh-add -K ~/.ssh/id_rsa
Copy the public SSH key to your clipboard save in a text editor without and extension. If your SSH key file has a different name than the example code, modify the filename to match your current setup. When copying your keydon’t add any newlines or whitespace.
pbcopy < ~/.ssh/id_rsa.pub # Copies the contents of the id_rsa.pub file to your clipboard.
Share the SSH public key with Solaris networking team
Now view the Testing your SFTP connection section.
- Once the SSH Public Key has been provided to Solaris, you will be sent the username, server name and port details, and a test file will be transferred to the account which you can access using your preferred SFTP client.
Testing the connection:
- If a public and private key have been generated via PuTTYgen , then simply insert the details like the server name, port number, username and attach the private key in your chosen SFTP client to connect to the SFTP account.
- If the public and private keys have been generated via OpenSSH , then during the process of attaching the private key you will be asked to convert the key file, as many SFTP clients do not natively support the private key generated by OpenSSH. You will need to convert the key to the supported format and attach that converted key to connect the SFTP account.
- Confirm the connection by uploading or downloading a file from the account.
- Once you confirm that you have successfully received the file, the team will send you the account set up file which will include your master account number, scheme code and API service URL.