Sterling B2B Integrator - Order Submission

Order submission entails the transmission of orders to the bank system from the EBICS Client. Orders are classified as Upload orders and Download orders based on whether an order is uploaded or downloaded by the bank system. Each order has to pass through different transaction phases during order processing.

Upload Order
A user sends an upload (FUL) request to the bank. FUL is a bank-technical upload order type. The upload transaction consists of the following stages:
  • Order initialization
  • Order processing

Order initialization

A user initiates an upload transaction with the bank by submitting an upload (FUL) order request. The EBICS Client Runtime component verifies the authorization level of the user and the number of required signatures to process the order. If the required criteria are met, then the order is processed and sent to the bank system. Else, the order is stored in the database and the Pending tasks page on EBICS Client dashboard interface is updated with the pending order details. When an EBICS Client user with pending orders (signing or submitting) logs in to the EBICS Client dashboard interface, the Pending tasks page opens prompting the user to sign or submit the order.

Order processing

Steps involved while processing an order submission which includes upload (FUL) bank-technical order type and key management order type are as follows:
  1. Order Packaging Module for encryption, authentication signatures, authorization signatures, encoding, and compression is invoked.
  2. Order ID is generated.
  3. If the order data exceeds the specified 1-MB size, the order data is segmented. A transaction log is maintained to record the segmentation.
  4. XML module to construct the EBICS request is invoked.
  5. Activity logging for updating the order state is generated.
  6. Appropriate mailbox storage is invoked for storing the order data.
  7. Events are collected and logged in to the database during each activity.
  8. The order data is submitted to the bank system.
  9. The post processing response received from the bank is stored in the user’s download mailbox.
Download Order
A user submits the download order type (FDL) to the bank. FDL order type is bank technical download order type. The download transaction consists of the following stages:
  • Order initialization
  • Order processing
  • Acknowledgement

Order initialization

A user initiates a download transaction with the bank by submitting a download (FDL) order request. The EBICS Client Runtime component verifies the authorization level of the user. If the required criteria are met, then the order is processed and sent to the bank system.

Order processing

Steps involved while processing an order response received from the bank system are as follows:
  1. The response received from the bank is stored in the download mail box for the user.
  2. Order Response Processor component is invoked to process the response.
  3. The Response Processor performs the following tasks:
    1. Invokes the Order Unpacking Module for decompression, decoding, and decryption.
    2. Invokes Order Concatenation if the response is segmented.
    3. Invokes Activity Logging for updating the order state.
    4. Collects and logs events in to the EBICS Client database during each activity.

Acknowledgement

After receiving the last segment of the order data from the bank, the client initiates the last phase, the acknowledgement request, to indicate that the data transfer is successful. If the bank receives a positive acknowledgement (receipt code=0) from the client, the bank moves the downloaded messages from the user download mailbox to the user archive mailbox. If the bank receives a negative acknowledgement from the client, the bank retains the downloaded messages in the user’s download mailbox.

Order Packaging

The order data is packaged according to the specified signing, compression, encryption, and encoding settings. For example, if the order type is FUL, the FULPackingHandler is invoked.

Order packaging also involves generation of unambiguous order IDs. EBICS Client allocates a unique order ID based on the bank, user ID, and the order type. The client generates the order ID as per EBICS specifications.
  • An order ID is a four character alphanumeric ID.
  • The first character is an alphabet. An EBICS Client user 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).
Order Data Segmentation

As per EBICS specifications for data transfer, the size of a compressed file, encrypted, and encoded order data must be less than or equal to 1-MB. If the size exceeds 1 MB after compression, encryption and encoding, then the order data is segmented such that each segment does not exceed the fixed 1-MB size. The segments are then transmitted sequentially in a consecutive order in individual EBICS messages.

Order Unpacking

Order unpacking involves decoding, decryption, decompression, and verification of the order data. It also involves logging orders for which the security operations have failed and the reasons for failure.

Segment Concatenation

The recipient system (server or client) executes the algorithmic computations in reverse order to recover the original order data. The data segments are sequentially appended, decoded, decrypted, and expanded to obtain the original order data.

Previous Topic

Sterling B2B Integrator - Configuration Requirements

Parent Topic

Sterling B2B Integrator - EBICS Server User