Payment output mapping

Payment output mappings define custom layouts for CSV output files used to send payment requests to banks or to print checks. By using custom payment output mappings, you can minimize downstream changes when new fields are added to the delivered CSV payment output.

Once defined, the payment output mapping is attached to a valid cash payment format.

After processing payments that use the cash payment format, the system generates the records and produces the CSV payment output file. When a payment output mapping is defined, the CSV Detail and Remittance sections follow the custom mapping rules. When no mapping is defined, the system uses the standard delivered layout.

See Creating cash payment formats.

Creating a payment output mapping header

Use this procedure to select which fields to populate on the payment output CSV file so you don't have to continuously update the downstream file mappers and processes.

  1. Select Cash > Administration > Setup.
  2. In the Payment panel, click Payment Output Mappings.
  3. Click Create.
  4. Specify this information:
    Payment Output Mapping
    Specify a unique ID for the mapping (example: BANK_ABC_DETAILEREM_CSV).
    Description
    Provide a description (example: Bank ABC CSV - Detail + Remittance Mapping).
    Note: Select the Active check box if the mapping is active and available for use.
    Delimiter
    Specify a delimiter, the default value is a comma.
    Remove Quotes Around Field Names And Values
    Select this check box to remove quotes around field names and values to accommodate evolving file formats.
  5. Click Save.

Defining the Detail mapping

Detail mapping contains all of the fields related to the payment. Use this procedure to define which fields - and the order by which the fields are shown - on the Detail tab of the CSV file. This enables you to add each field individually and control the layout of rows populated from PaymentOutputFileDetail in the CSV file.

Note: This procedure describes how to add each field individually. Optionally, you can select Actions > Create Remittance Field Mappings. This action automatically populates the Detail field using the delivered CSV output. After the fields are generated, you can delete, add, or modify mappings as needed.
  1. Select Cash > Administration > Setup.
  2. In the Payment panel, click Payment Output Mappings.
  3. Open a payment output mapping.
  4. On the Detail tab, click Create.
  5. Select the Mapping Type.
    Field
    This mapping type pulls a value from PaymentOutputFileDetail at runtime.

    This is only valid when Mapping Type = Field.

    Override Name - Specify a user-defined column name. The override name is used instead of the technical field name from PaymentOutputFileDetail and typically matches the payment type code used in Cash.

    Literal
    This mapping type writes a fixed string to the CSV file, such as a constant column header or bank code.
    When Mapping Type = Literal, specify:
    • Name - The column name.
    • Value - The literal value written to the column.
    Blank
    Writes an empty column to the CSV file and is useful when a spacer column is required.

    When Mapping Type = Blank, specify the column name in the Name field.

  6. Specify the remaining information as required:
    Field
    For each mapping line, select the source field from PaymentOutputFileDetail and position it as needed. Continue adding one row for each CSV column. Configure the fields to match the layout required by your bank or the printing process.
  7. Click Save.

Defining the Remittance mapping

Remittance mapping contains all of the details of each payment including invoice numbers and amounts. Use this procedure to define which fields - and the order by which the fields are shown - on the Remittance tab of the CSV file. This enables you to add each field individually and control the layout of rows populated from PaymentOutputFileRemittance in the CSV file.

Note: This procedure describes how to add each field individually. Optionally, you can select Actions > Create Remittance Field Mappings. This action automatically populates the Remittance field using the delivered CSV output. After the fields are generated, you can delete, add, or modify mappings as needed.
  1. Select Cash > Administration > Setup.
  2. In the Payment panel, click Payment Output Mappings.
  3. Open a payment output mapping.
  4. On the Remittance tab, click Create.
  5. Select the Mapping Type.
    Field
    This mapping type pulls a value from PaymentOutputFileRemittance at runtime.

    This is only valid when Mapping Type = Field.

    Override Name - Specify a user-defined column name. The override name is used instead of the technical field name from PaymentOutputFileRemittance and typically matches the payment type code used in Cash.

    Literal
    This mapping type writes a fixed string to the CSV file, such as a constant column header or bank code.
    When Mapping Type = Literal, specify:
    • Name - The column name.
    • Value - The literal value written to the column.
    Blank
    Writes an empty column to the CSV file and is useful when a spacer column is required.

    When Mapping Type = Blank, specify the column name in the Name field.

  6. Specify the remaining information as required:
    Field
    For each mapping line, select the source field from PaymentOutputFileRemittance and position it as needed. Continue adding one row for each CSV column. Configure the fields to match the layout required by your bank or the printing process.
  7. Click Save.