SFTP Batch Data Ingestion

In addition to the Data Ingestion API, Pagos offers a secure file transfer protocol (SFTP) option for bulk data ingestion. This method is preferred if you have large volumes of data that don't require immediate processing, such as historical data.

Setting Up SFTP Access

To get started with SFTP Batch Data Ingestion, you must first request SFTP access from your Pagos account manager. We will exchange keys for authentication and provide you with the following:

  • SFTP Host
  • SFTP Username

Naming Your Files

When naming your files for SFTP batch data ingestion, alway start with the type of data contained in the file (e.g. transactions, refunds, disputes, etc.). This is important for correct processing and ingestion, as we differentiate what type of data is being loaded by the prefix of the file.

For example:

  • transactions_timestamp_etc.csv
  • refunds_timestamp_etc.csv
  • disputes_timestamp_etc.csv

Uploading Files

To upload files to Pagos via SFTP:

  1. Connect to the SFTP server using the provided host and username credentials.
  2. Navigate to the designated upload directory.
  3. Upload your data files in the CSV format.
  4. Navigate to the designated receipt directory.
  5. Download the receipt and validate any errors.

📘

Note:

As a best practice, ensure all data objects are well-structured and valid.

Pagos systems will respond with a receipt file after processing the uploaded data file. This receipt file will describe any errors in detail to help you understand what needs to be fixed. You can find these receipts in a receipts directory on the same SFTP server to which you drop your data files.