Quick Start Recovery Integration Guide

Getting Started

FlexPay only accepts upload transaction files that are formatted correctly. Before you upload a transaction file, it is important that you understand how to format and customize transaction information. Preparing upload transaction files will decrease transaction validation and processing errors, which saves you time. 

Setup

• FlexPay will set up two subfolders for you in our SFTP: Inputs and Outputs. You will upload your input files to be processed to the Inputs folder and download the processed output files from the Outputs folder.
• Your Client Success Manager will provide you with credentials for the SFTP server.
• You will need to provide FlexPay with the IP address of the machine where you will be uploading the files from.

Naming Your Input Files

Your input file must adhere to the following format: <companycode>yyyyMMddHHmmss.txt

Where <companycode> is the character’s code you used to define your company code in FlexPay's Client Portal

Example:

Company Code: FP_01

File Name: FP_0120220115000000.txt

You can find the code by going to the Companies section under Account Settings.

Connection

System Requirements

• You will require an SFTP client software that must use SSH2.

File Upload Steps

To utilize the Quick Start Recovery process and obtain credit card authorization or any of the other operation types, you must have obtained an account, username, and password from FlexPay.

1. Establish a session with FlexPay's SFTP server host using your SFTP client software.
2. Log in using your credentials.
3. Upload the flat file. When uploading a file, it must be put in your Inputs folder.

Connection Details

To connect to the FlexPay Gateway SFTP server, you will require the following:

Input File Format

The file format is comma-delimited, with a txt extension, and no headers file. Attached to this document, you will find a sample with a handful of transactions to illustrate how the Input file should be formated.

• Required: Fields that are mandatory for the recovery process to work. The file won't pass our initial validation if these fields are not provided:
  • orderId
  • transactionType
  • currencyCode
  • amount
  • postalCode
  • billingCity
  • billingState
  • PaymentMethodMerchantAccountReferenceId (this is the MID / Merchant ID)
• Conditional: Fields that are conditional. You must provide one or the other. It's better if you can provide both.
  • referenceTransactionId (required only for REFUND or VOID)
  • customerID OR billingEmail
  • firstName & lastName OR fullName
  • creditCardNumber OR PaymentMethodGatewayPaymentMethodId (payment token stored at the gateway) OR PaymentMethodGatewayTransactionId

Fields listed as optional are"good to have" and can assist our machine learning models, but are not mandatory for the transaction to be processed.

Downloading Your Output File

If your file fails the validation stage, it will not be processed and our support team will contact you.

When it comes to the generation of the resulting output files, there are two different options available to you, please discuss with your CSM and they will configure it according to your needs. When a transaction is processed, the result of that transaction will only ever appear in one output file, so it's important you understand the process.

• Option 1: Get up to two output files per day for every input file. If your file is processed successfully, FlexPay will create a corresponding output file and make it available every day at 15:00 UTC and 22:00 UTC for download from your designated Output folder. For example, if a transaction is scheduled to retry (and is processed) at 14:00 UTC, it will appear in the output file at 15:00 UTC but not 22:00 UTC. This means that you'll need to ingest both output files in order to get the full list of what was processed.
• Option 2: Get one output file per day for all transactions processed the day before. It doesn't matter if the system processed transactions from 10 different input files, you will always have 1 output file a day containing the results of all of them. The file will be made available to you at 15:00 UTC.

Output File Format

The output file generated by FlexPay will contain the transaction results of all the transactions included in your input file. The file format is comma-delimited, with a txt extension, and no headers. The name format will depend on how many output files you're receiving per day (as described above). With Option 1, the name will match that of your input file with an underscore (_) and a time stamp. With Option 2, the name will stick to the following format <companycode>-3-yyyyMMdd.txt (date represents the day transactions were processed). See an output file template attached to this article.

Response Codes

Follow this link to see the full list of FlexPay Response Codes.