- SFTP File Delivery
- SFTP File Delivery
SFTP File Delivery
SFTP File Delivery
Connect over SFTP and exchange keys to download the outbound files Remitian publishes for you.
SFTP File Delivery lets your systems download the outbound files Remitian publishes for you, such as the daily payment file, which lists the tax payments of one firm for one day so you can reconcile payments in bulk without calling the API for each payment.
This guide covers the connection and the key exchange. For the available file types, decryption, and how to consume the files, see the SFTP File Specification guide.
How It Works
| Layer | Protocol | What it protects |
|---|---|---|
| Transport | SFTP (file transfer over SSH), key-based authentication only | The connection between your systems and Remitian. Passwords are not supported. |
| Encryption | PGP, with your PGP public key | The file content. Only you can decrypt it. |
| Signature | PGP, with the Remitian PGP signing key | Proof that Remitian made the file and that it was not changed. |
You generate and keep two key pairs on your side:
- SSH key pair (
ed25519or RSA 4096): authenticates your SFTP connection. - PGP key pair (RSA 4096): decrypts the files.
You share only the public keys with Remitian. Your private keys never leave your systems, and there are no passwords to exchange or rotate.
Environments
| Environment | SFTP Host | Port |
|---|---|---|
| Sandbox | sftp.sandbox.remitian.com | 22 |
| Production | sftp.remitian.com | 22 |
Sandbox and Production are fully separate: each has its own username, folder, keys, and fingerprints. Use a separate set of key pairs for each environment.
What You Get from Remitian
The SFTP Delivery section of the Developer Portal shows, for each environment:
| Item | Use |
|---|---|
| SFTP host and port | Where your SFTP client connects |
| Username | Your SFTP login. It is generated by Remitian and never changes. |
| Folder name | Your dedicated, isolated folder. Use it as a reference with our support team. |
| Server host public key and fingerprint | Confirms that you are connecting to Remitian |
| Remitian PGP signing public key and fingerprint | Verifies the signature of each file |
Set Up SFTP Delivery
The steps below require the Editor role in the Developer Portal.
1. Generate Your Key Pairs
Generate an SSH key pair for authentication:
ssh-keygen -t ed25519 -f ~/.ssh/remitian_sftp_sandbox -C "remitian-sftp-sandbox"
Generate a PGP key pair (RSA 4096) for decryption, then export its public key:
gpg --full-generate-key
gpg --armor --export you@yourcompany.com > pgp-public-key.asc
2. Upload Your Public Keys
In the Developer Portal, open SFTP Delivery and upload:
- Your SSH public key (for example, the content of
~/.ssh/remitian_sftp_sandbox.pub) - Your PGP public key (
pgp-public-key.asc)
Important: Upload public keys only. Never share a private key with Remitian or anyone else.
3. Enable SFTP Delivery
Enable SFTP delivery. The portal then shows your username, folder name, and the connection details listed above. Remitian publishes files for you only while SFTP delivery is enabled.
4. Import the Remitian Signing Key
Download the Remitian PGP signing public key from the portal and import it into your PGP tool:
gpg --import remitian-signing-public-key.asc
gpg --fingerprint
Check that the fingerprint shown by gpg matches the fingerprint shown in the portal.
5. Connect and Verify the Server
Connect with any standard SFTP client, using your username and your SSH private key:
sftp -i ~/.ssh/remitian_sftp_sandbox <your-username>@sftp.sandbox.remitian.com
On the first connection, your client shows the server host key fingerprint. Continue only if it matches the fingerprint shown in the portal. Your client then saves the key and checks it on every later connection.
For automated systems with strict host key checking, add the server host public key from the portal to your known_hosts file before the first connection:
echo "sftp.sandbox.remitian.com <server host public key from the portal>" >> ~/.ssh/known_hosts
Important: If your SFTP client ever reports that the server host key changed, do not connect. Contact support@remitian.com.
Your session opens in your own isolated folder. You can read your files only; you cannot see the files of any other integrator.
Key Rotation
You can register up to two SSH public keys at the same time, so you can rotate keys with no downtime:
- Generate a new SSH key pair.
- Upload the new public key in the portal.
- Update your systems to use the new private key.
- Remove the old public key from the portal.
To replace your PGP key, upload the new PGP public key in the portal. Files published after the change are encrypted with the new key, so keep your old private key until you have downloaded and decrypted all earlier files.
Network Access
If an IP allowlist is configured for your integrator account, SFTP connections are accepted only from the allowed IP addresses.
Need Help?
- Email: support@remitian.com
- Response Time: Within 1-2 business days