If you have an SFTP client configured you can click here to launch an FTP connection, thought you will still need to get a username and password using one of the methods described below.

Host	Port
sftp.authvia.com	421

Authentication

We support two ways of supplying a username and password for your SFTP connections. The recommended way is by creating a JWT and passing it as the password. Since JWT's expire, have specific grants and don't transmit a shared secret is is a far more secure option.

JWT

To authenticate using a JWT use our existing authentication logic to create a JWT, and make sure it has the jobs:create jobs:read scopes. Then pass the azp (client_id used to create the JWT) from the JWT as the username and the entire JWT as the password.

📘
Info
Password length cannnot be greater than 1000 characters, so you may need to limit your scopes if the JWT length exceeds 1000 characters.

The scopes in the JWT will determine what folders you have access to.

Required Scopes by Folder

Folder	Required Scopes	Description
`/customers`	`customers:create`	Create or update customers
`/payment-methods`	`payment_methods:create`	Create or update payment methods
`/payment-methods-delete`	`payment_methods:delete`	Delete payment methods
`/transactions`	`transactions:create`	Create transactions
`/messages`	`messages:create`	Send messages
`/files`	`files:create`, `files:read`	Upload and manage files
`/blueprints/{blueprint-id}`	`blueprints:create`	Create business processes via blueprints
`/blueprints/{blueprint-id}/events`	`blueprints:read`, `business_processes:update`	Interact with business processes via events
`/blueprints/{blueprint-id}/transactions`	`blueprints:read`, `transactions:create`	Create transactions via blueprints
`/business-process-events`	`business_processes:read`, `business_processes:update`	Interact with business processes directly

Merchant Product

Alternatively, if your circumstance does not allow for JWT creation you can have a fixed username and password by creating an Account Product (Merchant Product). You will define the password you want to use for your password and the AVID for the merchant will be the username.

🔑
Admin Access
This type of authentication is always going to be admin access to any and all behaviors.

{
  "line": "batch",
  "product": "sftp",
  "provider": "authvia",
  "config": {
    "password": "your,Password_Goes-Here"
  }
}

Available Folders

The following folders are available for batch/bulk operations based on your JWT scopes:

/customers - Create or update Customers. See the SFTP Customers reference for details.
/payment-methods - Create or update Payment Methods. See the SFTP Payment Methods reference for details.
/payment-methods-delete - Delete Payment Methods.
/transactions - Create Transactions. See the SFTP Transactions reference for details.
/messages - Send messages. See the SFTP Messages reference for details.
/files - Upload and manage files. See the SFTP Files reference for details.
/blueprints/{blueprint-id} - Create Business Processes through Blueprints. See the SFTP Blueprint Triggering reference for details.
/blueprints/{blueprint-id}/events - Interact with Business Processes via events. See the SFTP Blueprint Events reference for details.
/blueprints/{blueprint-id}/transactions - Create transactions through blueprints.
/business-process-events - Interact with Business Processes directly.

📘
ID Seed
Its not uncommon in batch situations using the ID created by the Authvia platform, is not useful, or available. Its recommended you make use of our id seed's in your files so you can not only create, but then update and associate data as needed with any bulk/batch behavior.

Limits

File Length

We do not have any known limits at this time for file length. Testing has been done up to 1MM lines and while duration increases, the amount of data in the file and the behavior operation being executed both have an impact on that duration.

Column Length

The number of columns also does not have any known length. In general, we disregard all columns that do not apply to the operation being requested. We do as that you be reasonable with what data you send across, its best to only send whats needed and to avoid sending data that can be statically defined in a blueprint. Given that we have a pretty rich set of interpolation behaviors your engineers or our support can help reduce the file size, if it poses any problems.

File Name

Duplicate file names will be rejected as duplicates. Always use unique file names.

File Contents

If the contents between files are identical, the second file will be rejected as a duplicate. The headers and all lines must be the same, adding a character to a reference field gets around this error.