Submitting Orders

Sterling B2B Integrator EBICS Client Users can submit orders using the Order submission feature in the User Menu.

If the order that is submitted requires signatories to sign the order, then a pending task is created for the signatory. After the required number of signatures are obtained for the order, the order is submitted to the bank. The Order Submission page helps you to configure order settings and submit an order.
  1. Log in to Sterling B2B Integrator EBICS Client.
  2. From the User Menu, click Order submission. Specify the values for the fields according to the instructions in the following table and click Next.
    Field Description
    Partner ID Required. Select a partner name from the drop-down list.
    Bank ID(Host ID) Required. Select a bank ID associated with the partner from the drop-down list.
    Bank URL Required. Select the required bank URL from the drop-down list. The selected URL is used to establish an HTTP or HTTPS session with the EBICS Banking Server.
    Order type filter Required. From the drop-down list, select the appropriate order type:
    • Key management orders
    • Bank technical orders
    • VEU/EDS management orders
    • Other order types
    Order type Required. From the drop-down list, select the required order type.

    Order types are assigned to the offer and are represented by a 3-digit alphanumeric code that identifies the type of the order.

    Order types are displayed based on the user permission configured for the EBICS Client user.
    Note: The fields that you see in the Order Type Configuration page varies based on the order type you selected from the Order type drop-down. Therefore, it is important that you select an appropriate order type. For example, if you select the order type as INI, then the fields specific to INI are displayed for configuring the order.
  3. If you selected Key management orders as Order type filter, then specify the values for the fields according to the instructions in the following table and click Send.
    Field Description
    Order ID prefix Optional. From the drop-down list, select the order ID prefix. EBICS Client allocates a unique order ID to each order based on the bank, user ID, and the order type. The client generates the order ID as per EBICS specifications. The order ID is a 4-digit alphanumeric ID. You can specify the first character of the order ID. The second, third, and fourth characters of the order ID are alphanumeric in an ascending order (A-Z or 0-9).

    This field is applicable to all the key management order types.

    Security medium A 4-digit security number is displayed by default. The value cannot be changed for INI, HIA, and HPB order types.
    Product ID Enter the product ID for the EBICS Client application.
    Product language Enter the language setting of the EBICS Client application that you are using. For example, enter EN if the language is set to English.
    Authentication private certificate Required. From the drop-down list, select the appropriate authentication private certificate.
    Authentication public certificate Required. From the drop-down list, select the appropriate authentication public certificate.
    Authentication key version The key version of the authentication certificate is displayed. Valid value is X002.
    Encryption private certificate Required. From the drop-down list, select the appropriate encryption private certificate.
    Encryption public certificate Required. From the drop-down list, select the appropriate encryption public certificate.
    Encryption key version The key version of the encryption certificate is displayed. Valid value is E002.
    Electronic signature private key Required. From the drop-down list, select the appropriate electronic signature private key.
    Electronic signature public key Required. From the drop-down list, select the appropriate electronic signature public key.
    Electronic signature key version Required. From the drop-down list, select the appropriate electronic signature key version.
  4. If you selected Bank technical orders as Order type filter and Order type as:
    • BTU. Specify the values for the fields according to the instructions in the following table and click Send.
      Order ID prefix Optional. From the drop-down list, select the order ID prefix. EBICS Client allocates a unique order ID to each order based on the bank, user ID, and the order type. The client generates the order ID as per EBICS specifications. The order ID is a 4-digit alphanumeric ID. You can specify the first character of the order ID. The second, third, and fourth characters of the order ID are alphanumeric in an ascending order (A-Z or 0-9).
      Security medium Required. Type a 4-digit security number in 0100 to 0499 range.
      Autosubmit Optional. This check box is applicable only for BTU order type and is selected by default.

      If the option is selected, then an order is automatically submitted after the required number of signatures are obtained.

      If the option is not selected, then an EBICS Client user has to log in to the EBICS Client dashboard interface, navigate to the pending tasks screen, and submit the order after the required number of signatures are obtained.

      Read file from mailbox Required. This option is applicable only for BTU order type.

      To upload the payload file from the mailbox, select Yes. Click Select file next to Upload file. From the Select file to upload to mailbox list, select the required file and click Finish.

      To upload the payload file from a file location, select No. Click Browse next to Upload file, navigate to the file location and select the required file.

      Upload file Required. This option is applicable only for BTU order type.

      To upload payload file from the mailbox, click Yes.

      To upload payload file from a file location, click No and click Browse to navigate to the file location.

      Read file name. Optional. Select the check box to send the name of the input file in payload, which is used for debugging purpose.
      BTF Service Required. The BTF Service associated with the order type. Select the BTF Service (Service Name, Message Name, Service Scope, Service Option, Container Type) from the table.
      Signature Flag Optional. Select the check box to indicate the presence of an electronic signature.
      Request EDS Optional. Select the check box to authorize the order within EBICS.
      Additional Order Info Optional. Include additional details of the order.
      Order parameter list Optional. Click Add parameter to define variables for an order. Complete the information pertaining to the following order parameter fields and click Add parameter. This option is applicable only for FDL order type.
      • Name: Required. Type a unique name of the parameter. Do not use any spaces or special characters in the parameter name.
      • Value: Required. Type a value of the parameter.
      • Type: Optional. Select the parameter type. The available choices are:
        • String
        • Number
        • Boolean
    • BTD. Specify the values for the fields according to the instructions in the following table and click Send.
      Security medium Required. Type a 4-digit security number in 0100 to 0499 range.
      BTF Service Required. The BTF Service associated with the order type. Select the BTF Service (Service Name, Message Name, Service Scope, Service Option, Container Type) from the table.
      Start date Optional. Click the field and select the start date from the calender. This option is applicable only for FDL order type. This date range helps you while searching the orders by using the order search page.
      End date Optional. Click the field and select the end date from the calender. This option is applicable only for FDL order type.
      Order parameter list Optional. Click Add parameter to define variables for an order. Complete the information pertaining to the following order parameter fields and click Add parameter. This option is applicable only for FDL order type.
      • Name: Required. Type a unique name of the parameter. Do not use any spaces or special characters in the parameter name.
      • Value: Required. Type a value of the parameter.
      • Type: Optional. Select the parameter type. The available choices are:
        • String
        • Number
        • Boolean
  5. If you selected VEU/EDS management orders as Order type filter, then specify the values for the fields according to the instructions in the following table and click Send.
    Order ID prefix Optional. From the drop-down list, select the order ID prefix. EBICS Client allocates a unique order ID to each order based on the bank, user ID, and the order type. The client generates the order ID as per EBICS specifications. The order ID is a 4-digit alphanumeric ID. You can specify the first character of the order ID. The second, third and fourth characters of the order ID are alphanumeric in an ascending order (A-Z or 0-9).
    Security medium Required. Type a 4-digit security number in 0100 to 0499 range.
    OrderID Required. Specify the ID of the order for which you are submitting the HVE or HVS order type only.
    PartnerID Required. Specify the ID of the partner associated with the user who submitted the order for which you are submitting the HVE or HVS order type only.
    BTF Service Required. The BTF Service associated with the order type. Select the BTF Service (Service Name, Message Name, Service Scope, Service Option, Container Type) from the table.
    Hash Value
    Optional. You can submit either the hash value of the order data or the complete payload. Valid values are:
    • Message Digest - To submit the hash value of the order data.
      Note: You can request for the hash value by calling or mailing the bank. The bank sends the hash value of the order data through an alternate mode of communication. For example, email.
    • PayloadMsgID - To submit the complete payload from your mailbox. Perform the following actions:
      1. Click Select.
      2. Select the required payload from the list.
      3. Click Finish.
      Note: You can request for the payload by calling or mailing the bank. The bank sends the payload to your EBICS Client mailbox.
  6. If you selected Other order types as Order type filter, then specify the values for the fields according to the instructions in the following table and click Send.
    Order ID prefix Optional. From the drop-down list, select the order ID prefix. EBICS Client allocates a unique order ID to each order based on the bank, user ID, and the order type. The client generates the order ID as per EBICS specifications. The order ID is a 4-digit alphanumeric ID. You can specify the first character of the order ID. The second, third, and fourth characters of the order ID are alphanumeric in an ascending order (A-Z or 0-9).
    Security medium Required. Type a 4-digit security number in 0100 to 0499 range.