Updating Contacts via SFTP

Contacts can be updated in Payreq Delivery by sending a Contact file to Payreq via SFTP. This method is generally used by Mailers or print service providers who regularly supply Contact data as part of an automated or recurring process from a billing, rating, payroll or source system.

A complete technical overview can be found in the Payreq Interface Specification.

How the SFTP process works

1. The Mailer or mailhouse prepares a Contact file
2. The file is uploaded to Payreq’s SFTP server
3. Payreq processes the file
4. Contact records are added, updated or replaced according to the file and header instructions
5. Payreq generates an acknowledgement file after processing is complete
6. The Mailer or mailhouse reviews the acknowledgement file and reviews Subscriptions flagged Deregister?

File Requirements

Contact files must be supplied in CSV format.

Each Contact file must contain:

• One header record
• One or more Contact records
• One trailer record

The file name can be chosen by the Mailer or mailhouse, provided that:

• Each file name is unique
• The file extension is .csv
• The file name only uses standard US ASCII characters
• Accented characters and control characters are not used in the file name

Header record: Choosing the correct file type identifier

The first row in the file must be the header record.

The header record identifies the file being sent to Payreq and tells Payreq how the file should be processed. The File Type Identifier is important because it controls how Payreq processes the Contact file.

Use ADD_CONTACTS when the file should:

• Add new Contacts
• Update matching existing Contacts
• Leave other existing Contacts unchanged

Use REPLACE_CONTACTS only when the file contains the full Contact list that should remain in Payreq Delivery. A replacement Contact file should be used carefully, because Contacts not included in the file may no longer remain available in the same way after processing.

Before sending a replacement file, confirm that:

• The file contains all required Contacts
• Existing Contact IDs have been retained where appropriate
• The possible effect on active subscriptions has been considered
• The file has been reviewed by the appropriate person within your organisation or mailhouse

Contact fields

The Contact file includes multiple configurable Contact fields. These fields are important because they are used to match subscription requests to the correct Contact record.

For more information see Understanding Contact Field Settings.

The mandatory Contact fields are:

The required values and field usage should be confirmed during onboarding and can be reviewed in the Payreq Delivery console settings.

Uploading the File

To send the Contact file to Payreq:

1. Prepare the Contact file in the agreed CSV format
2. Connect to Payreq’s SFTP server using the credentials provided to your organisation
3. Place the file in the /incoming directory
4. Allow Payreq to process the file
5. Review the acknowledgement file once processing is complete

Do not upload the same file more than once unless instructed to do so by Payreq Support.

Acknowledgement Files

After Payreq has processed the Contact file, an acknowledgement file is sent to the Payreq SFTP outbound folder. The acknowledgement file provides the overall result of the Contact load, and includes:

• The file name received by Payreq
• The overall processing status
• A message confirming the result or explaining the failure
• The original header provided in the Contact file
• The trailer count

The overall status will indicate whether the file was processed successfully or whether an error occurred:

• OK - the file was processed successfully
• ERR - the file failed processing and requires investigation

If your organisation does not require acknowledgement files, this can be discussed with Payreq during onboarding or by contacting Payreq Support.