Transformations and Validations

Configuration
Written By Tad Staley

For integrations based on flat-file exports from PaymentWorks, there are a number of simple validations and transformations that can be configured in PaymentWorks that can be used to format the data for the destination system.

Validations

PaymentWorks registration forms can be configured to guarantee that for some field types, data entered by the supplier will be delivered in the correct format. These validations are available only for single line of text entry fields:

  • Date. This validation enforces proper date format (and also includes a date picker interface for the supplier). The format of the value exported will be yyyy-mm-dd.

  • Email address. PaymentWorks confirms that the entered value is in an addressable format. It does not validate that the email address is the correct address for the recipient.

  • Phone number. PaymentWorks validates the phone number is in a viable format. The number will be exported in E.164 format.

PaymentWorks can also limit the length of data entered by suppliers. When the supplier reaches the specified length they will be notified of the limit and will be unable to add any more data.

Transformations

There are several ways a PaymentWorks Payer account can be configured so that the values that are provided by the supplier are transformed to expected values in your ERP. Notes:

  • These transformations are enabled through changes to the PaymentWorks Payer account and must be configured by PaymentWorks’ technical team.

  • These translations can also be performed outside of PaymentWorks through code in an automated integration.

1. Field Value Modifications

The export process can also perform the following modifications to the data when exported. Note that the supplier’s actual profile data remains unchanged, so there could be a discrepancy between the values they provide and the values inserted into the ERP.

The following changes can be made on a field-by-field basis

  • Truncation: Used when the PaymentWorks field length exceeds the ERP’s. Where possible, it’s better to configure the field limitation in the form itself.

  • Case changes: forcing entered value to be exported as all upper or lowercase

  • Allowable Characters: digits only, letters only, or digits and letters only. The PaymentWorks export can also strip international characters from the field value.

  • Whitespace handling: this is the ability to strip leading, trailing, or all spaces.

  • Replace Unicode characters with English equivalents where possible.

2. Lookup Translations

PaymentWorks can be configured so that the values displayed to and selected by the supplier can be translated to values expected by the ERP. This applies to dropdown and multi-select fields only.

For example, a typical registration form includes custom fields to determine a supplier’s 1099 status. PaymentWorks can translate the values selected by the supplier to codes expected by the ERP, as shown in the table below:

Note: Currently this configuration must be done administratively by PaymentWorks personnel.

3. Export Columns

PaymentWorks can be configured to export some or all of the available fields (as columns) and can determine the order as well as the contents of each column:

Columns to include: Many Payers prefer to leave selected supplier data in PaymentWorks rather than bring it into the ERP. This can include fields like insurance or diversity documentation. In this case you may omit these columns from the export.

Column export order: PaymentWorks can be configured to export columns in whatever order is convenient for the integration process.

Values to include: There may be cases where you want to omit a field’s value from the export, but do not want to disrupt the column order and numbering. In this case you may want to include the field (column) but not export its values. The settings for each field are:

  • Header & Values (default)

  • Header Only

  • Empty Column

Next Steps

To learn more about PaymentWorks integration options or to discuss your specific area of interest or concern, please reach out to set up a complimentary consultation. We’d be happy to connect!

You can fill out this form including an overview of your interest, or simply email us directly at bestpractices@nvrpartners.com.

Tad Staley
Previous

Integration Project Outline