SFTP Configuration
Use SFTP to exchange payment reconciliation files, transaction reports, and settlement reports with EBANX over an encrypted SSH connection.
What is SFTP?
SFTP (SSH File Transfer Protocol) is a secure protocol that runs over an encrypted SSH connection. It transfers files between a client and a server without exposing data in transit.
By integrating SFTP, merchants can send and receive daily payment reconciliation files, transaction reports, and settlement reports, keeping the exchange automated.
Configuration Requirements
To connect to the EBANX SFTP server, provide the following details:
| Parameter | Description | Example |
|---|---|---|
| Hostname | SFTP server hostname for the target environment. | files.ebanx.com (Production)files-sandbox.ebanx.com (Sandbox) |
| Port | SFTP server port. | 22 |
| Username | Username assigned to your account. | <sftp-username> |
| Private SSH Key | The private key that matches the public key registered with EBANX. This can be created with the steps below. | id_rsa |
Password authentication is not supported. EBANX SFTP connections require key-based authentication only.
Create an SSH Key Pair
Generate a 2048-bit RSA key pair on this website, which will be used to connect to the SFTP server.
Replace any text between < and > with your own value when running the commands below.
macOS and Linux
Set restrictive permissions on the private key:
chmod 400 <filename>
Windows
On Windows 10 or newer, run this command in Command Prompt to set read-only permissions on the private key:
icacls "%USERPROFILE%\.ssh\<filename>" /inheritance:r /grant:r "%USERNAME%:R"
Register the Public Key with EBANX
Send the generated .pub file to your EBANX representative using the following email template.
Make sure the email subject and body include the required details so the setup can be completed without follow-up.
Subject
SFTP <Company Name> Integration - Public Key Registration
To: your EBANX contact
Body
Expected folder title: <folder_title>
Environment: <Production/Sandbox>
Preferred username: <username>
- Expected folder title: If left empty, the company name will be used. If the name already exists, EBANX will contact you for clarification.
- Environment: Specify whether the key is for the production or sandbox SFTP server.
- Preferred username: Optional. If not declared, the username will be the same as the expected folder title.
Still need help?
We hope this article was helpful. If you still have questions, you can explore the following options:
- Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
- Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.
