SlimPay Help Center

File API Overview

Protocol

Our File API is mainly accessible via SFTP. We can also configure specific connections on demand.

Two environments are accessible:

  • Preprod: For your development and testing phases.
  • Production: Once your tests are conclusive, start doing real transactions.

For each environment, you need to provide your public key. Once your access is created, you will be provided with:

  • The host
  • The port
  • Your username

A dedicated folder will then be created for you. This folder contains two subfolders:

  • in: you drop your files here
  • out.ack/.err and reporting files will be dropped here by SlimPay

Connection

Here is an example of a standard way to connect using command-line:

sftp -o Port=<port> -o IdentityFile=<path_to_private_key> <username>@<host>

Format

Most of the actions available in our File API can be sent using a simplified CSV format. The charset should be UTF-8 and the separator between the fields a semi-colon.

For now, the documentation for each format is not entirely online but you can ask for them by submitting a request.

Acknowledgement and Errors Handling

  1. You send us a file.
  2. It is immediately parsed. Two possibilities:
    • The file is correctly formatted: a file with the same name but with the extension .ack is created.
    • The file is incorrectly formatted: a file with the same name but with the extension .err is created with the error message(s) in it.
  3. The file is then processed. "When?" depends on your account configuration.
  4. Depending on the file sent, another reporting file can be created to signal an error post-processing.

In other words, an acknowledged file does not necessarily mean that the file was processed successfully but that its format is correct.

Take the direct debits creation file: a .ack file is created and when processing, the system finds out one of the mandates used is revoked. A NOP file is then generated for the affected payment.

Was this article helpful?
0 out of 0 found this helpful