Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure additional lockbox settings

Learn how to configure additional settings for lockbox, including payment field mapping, SFTP credentials, and notification settings.

After the initial configuration is completed for a lockbox, you can configure payment field mapping, SFTP upload credential and schedule, and notification settings.

  • Mappings and Options - Optionally, adjust the mapping relationships that are configured in Step 2.

  • SFTP Settings - Configure the SFTP server that stores lockbox files and a schedule to download files from the server.

    Complete Credential details:

    • Host - Enter the IP address of the SFTP server.
    • Port - Enter the port number of the SFTP server.
    • Username - Enter the username to authenticate to the server.
    • Use Key Based Authentication - Specify whether to use the key-based authentication.
    • Password - If Use Key Based Authentication is not checked, you must enter the password of the user. If Use Key Based Authentication is checked, you can optionally enter the password of the user.
    • Private Key - If Use Key Based Authentication is checked, you must enter the private key of the user. The Lockbox application currently supports only RSA private keys. You can generate an RSA key in PEM format using the following command: ssh-keygen -t rsa -m PEM -f my_rsa_key Support for OpenSSH private key formats is not available at this time, but we may consider adding this enhancement in the future. Private key will be like: ----BEGIN RSA PRIVATE KEY---- ... ----END RSA PRIVATE KEY---- The trialing new line is optional. If you are an SFTP user, you must have permission to access the folder path mentioned in the SFTP configuration in Lockbox.
    • Passphrase - If Use Key Based Authentication is checked, you can optionally enter the passphrase of the user.
    • Path - Identify the location of the lockbox files. The path provided should be a directory path because the feature can fetch multiple files from the directory. For example, /outbound/LBX01. The uploaded file format for Fixed Width Text - Single-Record Type (FWTSR) and Fixed Width Text - Multi-Record Type (FWTMR) should be a .txt file.
    • Delete After - Select whether lockbox file should be deleted after being obtained.

Ensure your SFTP server is SSH enabled for the Lockbox Application to connect; otherwise, you might get an authentication error when setting up the SFTP server.

  • SFTP will continue to run until the folder is empty.
  • Click Save.

Optionally, complete the Schedule details. If no schedules are defined, you can manually download lockbox files by selecting Run Automated File Download from the menu of the lockbox.

  • Timezone - Select the same time zone as for the tenant to avoid payment errors

  • Select to begin schedule builder - Identify time frame of run schedule

    Yearly, Monthly, Weekly, Daily, Hourly, Minutes

    Complete specific time frame details. Start times are in military time.

For example, company Z will perform a monthly lockbox run at the beginning of the third day of the month.

  • Select to begin schedule builder: Monthly

  • Complete Specific Details for Monthly builder:

    • Select Day 3 (input data) of every 1 (input data) month(s)
    • Start Time: 00:01

Notification Settings - Specify emails to receive notification of completed runs. The To line is required.