Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure response codes

Learn how to configure response code mappings for payment gateways, including editing retry rules and adding custom code labels.

The response code mapping for each gateway is presented on the Response Codes tab. Each response code is mapped to one of the code labels, including the built-in labels ( Hard Decline , Soft Decline , System Error ) and the custom labels.

Only one custom payment gateway created through the Universal Payment Connector (UPC) service can be supported in Configurable Payment Retry.

If you plan to edit the retry rules manually based on gateway response codes, complete the following steps to configure the response code mapping:

  1. Click the Response Codes tab. The default response code mapping is shown on the Response Codes tab if you did not edit the mapping previously. The default mapping is a recommendation. A response code can be reassigned to other available code labels.
  2. On the Response Codes tab, configure the response codes and mappings for your needs:
    • To reassign response codes to other available code labels, click the Edit icon in the upper right and click the radio button under the desirable code label. You can use the Gateways filter and the Search bar to quickly locate the response codes. After you complete your editing, click Save All Mappings .

    • To add a custom code label, complete the following steps:

      1. Click the Menu icon in the upper right and then click Edit Code Labels .

      2. In the Edit Code Labels window that opens, click Create Code Label .

      3. Input the name and description for the custom label and click Create . You can delete a custom label if no response code is mapped to this label.

    • To edit the response codes in batch by importing your own mapping file, complete the following steps:

      1. Click the Menu icon in the upper right and then click Bulk Edit Response Codes .

      2. In the Bulk Edit Response Codes window that opens, export the code list as the base for your editing by clicking Export CSV and then selecting Master Code List or My Code List . The Master Code List is a template in CSV format that contains gateway response codes and suggested code mappings. The Master Code List may not contain all response codes applicable to the gateway. Check with your gateway to ensure all codes are correctly listed and mapped. The My Code List is a CSV file containing the current code list and mappings.

      3. Edit the exported CSV file to include new response codes in your mapping. Make sure the following rules are met.

        • Gateway names and code labels are case-sensitive.
          Note: You must use the payment gateway type names. Use the List all payment gateways REST API to identify the gateway type names. In the response, the type field of each returned gateway indicates the type name of that gateway.
        • Only existing code labels can be mapped to codes. New code labels can be added only through the UI (Menu icon > Edit Code Labels > Create Code Label ).

        • Duplicate response codes are not accepted.
          Note: The addition of new codes will not be added to the master list.
      4. When you complete your editing, in the Bulk Edit Response Codes window, import the custom CSV file by choosing it from your computer and clicking Import CSV . Once imported, the new code list will override the existing code configuration.
        Note: Importing a new CSV will override all existing response code configurations.