Sterling B2B Integrator - Return codes
When using EBICS Client, you may receive return codes and event messages.
Return codes for events
The tables here list the return code, the corresponding event message and a brief description of the return code.
Return Code | Event Message | Summary |
|---|---|---|
| EBICSCL2302 | Order Data Compressed | Indicates that the order data of the transaction is compressed. No action required. |
| EBICSCL2303 | Order Data Encrypted | Indicates that the order data of the transaction is encrypted. No action required. |
| EBICSCL2304 | Order Data Encoded | Indicates that the order data of the transaction is encoded. No action required. |
| EBICSCL2305 | Order Data Signed | Indicates that the order data of the transaction is signed. No action required. |
| EBICSCL2306 | Order Data Decompressed | Indicates that the order data of the transaction is decompressed. No action required. |
| EBICSCL2307 | Order Data Decrypted | Indicates that the order data of the transaction is decrypted. No action required. |
| EBICSCL2308 | Order Data Decoded | Indicates that the order data of the transaction is decoded. No action required. |
| EBICSCL2309 | Signature Data Compressed | Indicates that the signature data of the transaction is compressed. No action required. |
| EBICSCL2310 | Signature Data Encrypted | Indicates that the signature data of the transaction is encrypted. No action required. |
| EBICSCL2311 | Signature Data Encoded | Indicates that the signature data of the transaction is encoded. No action required. |
| EBICSCL2312 | Signature Data Decompressed | Indicates that the signature data of the transaction is decompressed. No action required. |
| EBICSCL2313 | Signature Data Decrypted | Indicates that the signature data of the transaction is decrypted. No action required. |
| EBICSCL2314 | Signature Data Decoded | Indicates that the signature data of the transaction is decoded. No action required. |
| EBICSCL2300 | EBICS Packaging Passed | Indicates that the packaging of the order data was successful. No action required. |
| EBICSCL2301 | EBICS Packaging Failed | Indicates that the packaging of the order data was not successful. A few of the reasons for the failure of packaging may be a result of failure when compressing order data, or encrypting order data, or erroneous keys used in signature or encryption. Review the list of events using Event Viewer from the EBICS Client dashboard interface. |
| EBICSCL2500 | EBICS Unpackaging Passed | Indicates that the unpackaging of the order data was successful. No action required. |
| EBICSCL2501 | EBICS Unpackaging Failed | Indicates that the unpackaging of the order data was not successful. A few of the reasons for the failure of unpackaging may be a result of failure when decompressing order data, or decrypting order data, or erroneous keys used in signature verification. Review the list of events using Event Viewer from the EBICS Client dashboard interface. |
| EBICSCL2318 | Valid Response Received | Indicates that you have received a valid response from the server when you submit an order type. |
| EBICSCL2319 | Erroneous Response Received | Indicates that the server returned an erroneous response for a particular order request. For more information about the response, view the list of events using Event Viewer from the EBICS Client dashboard interface for technical and business return codes. |
| EBICSCL2320 | EBICS Initialisation Request Passed | Indicates that the request has been initialized. |
| EBICSCL2321 | EBICS Data Transfer Request Passed | Indicates that the request for transfer of data has been accepted by the bank. |
| EBICSCL2322 | No Submitter Authority | Indicates that you do not have the user permission to submit an order. Configure the user permission for the role with authorization level set to T and permission type set to Submitter. |
| EBICSCL2323 | Unpackaged data writing to Mailbox success | Indicates that the data was unpackaged and stored in the user mailbox. |
| EBICSCL2324 | Unpackaged data writing to Mailbox failure | The failure to write unpackaged data to a mailbox may be a result of inadequate permission to access mailbox. For more information, see the ebicsClient.log file. |
| EBICSCL2325 | Pending Tasks created for Authorizers | Indicates that pending tasks are created for the user. View the list of pending tasks to be signed using the EBICS Client dashboard interface. |
| EBICSCL2326 | Pending Tasks created for Submitter | Indicates that pending tasks are created for the user who is authorized to submit orders. View the list of pending tasks to be submitted using the EBICS Client dashboard interface. |
| EBICSCL2327 | Signature generation successful for Authorizer | Indicates that the signature generation was successful when a signatory signed an order that was pending for signature. |
| EBICSCL2328 | Signature generation failed for Authorizer | Indicates that the signature generation was unsuccessful when a signatory signed an order that was pending for signature. |
| EBICSCL2329 | OrderType is invalid | Indicates that the order type specified is invalid. Specify a valid order type. |
| EBICSCL2330 | HostID is invalid | Indicates that the host ID or the bank ID specified is invalid. Specify a valid host ID. |
| EBICSCL2331 | PartnerID and UserID combination is invalid | Indicates that the user ID and the associated partner ID combination is invalid. Specify a valid combination of user ID and associated partner ID. |
| EBICSCL2332 | SystemID is invalid | Indicates that the system ID specified is invalid. Specify a valid system ID. |
| EBICSCL2333 | Missing mandatory parameter in order metadata | Indicates that a mandatory parameter in the order metadata is not included. Review the ordermetadata.xml for the missing parameter and specify a valid value for the parameter. |
| EBICSCL2334 | Security Medium is invalid | Indicates that the value specified for security medium is not valid. Enter a four-digit security number in the 0100 – 0499 range. |
| EBICSCL2335 | Unable to parse Primary Document in Workflow | Re-check configuration and initiate transaction. |
| EBICSCL2336 | Encryption Public Key not found for Bank | Upload a valid encryption key. |
| EBICSCL2337 | Could not retrieve Key for usage | When signing or encrypting order data, the key to the alias could not be retrieved. |
| EBICSCL2338 | Segment Upload to Host | The order data segment was successfully uploaded to the server. |
| EBICSCL2339 | Segment Download from Host | The order data segment was successfully downloaded from the server. |
| EBICSCL2340 | Calculated Total Number of segments to be Uploaded | EBICS Client calculates the total number of segments of an order data that is to be uploaded. |
| EBICSCL2341 | Got Total Number of segments to be Downloaded | EBICS Client receives the total number of segments of an order data that is to be downloaded. |
| EBICSCL2342 | Auto Submit value is invalid | Indicates that the value defined for autosubmit is not valid and therefore the order cannot be automatically submitted. Enter a valid value for the autosubmit parameter. Valid values are true and false. |
| EBICSCL2343 | Country code value is invalid | Indicates that the abbreviation for a country is not valid. Specify a valid format for country abbreviations. |
| EBICSCL2344 | Host not yet Active | Indicates that the server at the bank is not yet active. Download the bank keys using the HPB order type and validate the bank keys. |
| EBICSCL2345 | User not yet Ready | Indicates that the subscriber initialization for the user is not yet complete. Generate the INI and HIA letters for the user associated with the partner and send them to the bank for validation. |
| EBICSCL2346 | Response data writing to Mailbox success | Indicates that the response received from the bank was successfully stored in the mailbox. |
| EBICSCL2347 | Response data writing to Mailbox failure | The failure to write response data to a mailbox may be a result of inadequate permission to access mailbox. For more information, see the ebicsClient.log file. |
| EBICSCL2348 | Error putting message into Mailbox | Indicates that the message could not be uploaded to the mailbox. |
| EBICSCL2349 | No Response from Server | Indicates that the server did not respond when a request was sent to the server. |
| EBICSCL2350 | Invalid response from Server | Indicates that the server returned an invalid response when a request was sent to the server. |
| EBICSCL2392 | Mandatory Parameter for HttpClient missing | Indicates that the name of the configured http client adapter is null, or adapter properties are missing, or if the host or port is not configured properly. If SSL is enabled, CA certificate is not configured. |
| EBICSCL2393 | HttpClient Instance Not Found | Indicates that the http client adapter instance is missing. |
| EBICSCL2394 | Error in Ending HTTP Session with Server | Indicates that an error occurred when ending the HTTP session with the server, which may be a result of not finding a valid session. |
| EBICSCL2395 | Host Not Found | Indicates that the host or port is not configured properly. |
| EBICSCL2396 | Handshake Failure | When connecting to the server using SSL. the connection may be unsuccessful, for example, because of invalid certificates. |
| EBICSCL2398 | Could not complete connection to specified host | Indicates that the client was unable to connect to a host even when the session was successfully started. |
| EBICSCL2351 | Invalid key length for signature | Indicates that the length of the bank-technical keys is invalid for signature. Ensure that the key length is equal to or greater than 1536 bit and equal to or lesser than 4096 bit. For information about defining EBICS-specific key lengths for electronic signature, encryption, and authentication, see EBICS Specification, version 2.4.2. |
| EBICSCL2352 | Invalid key length for authentication | Indicates that the length of the bank-technical keys is invalid for identification and authentication. Ensure that the key length is equal to or greater than 1024 bit and equal to or lesser than 16384 bit. For information about defining EBICS-specific key lengths for electronic signature, encryption, and authentication, see EBICS Specification, version 2.4.2. |
| EBICSCL2353 | Invalid key length for encryption | Indicates that the length of the bank-technical keys is invalid for encryption. Ensure that the key length is equal to or greater than 1024 bit and equal to or lesser than 16384 bit. For information about defining EBICS-specific key lengths for electronic signature, encryption, and authentication, see EBICS Specification, version 2.4.2. |
| EBICSCL2354 | Error in starting HTTP Session with Server | Indicates that an error occurred when starting an HTTP session with the server. |
| EBICSCL2355 | Error in parsing OrderMetadata Document with Message ID | Check whether the XML is well-formed or not. |
| EBICSCL2356 | Technical Subscriber does not have permissions to be a delegate of the User specified | Configure technical user and associate the technical user with an existing user. |
| EBICSCL2357 | Error while trying to retrieve message from Mailbox | Indicates that an error occurred when retrieving a message from the mailbox. |
| EBICSCL2358 | Error in parsing OrderMetadata Document | Check whether the XML is well-formed. |
| EBICSCL2359 | Signature Application Rejected | Signature application rejected because the signature requirements were already met for the order. |
| EBICSCL2360 | Submission Application Rejected | Submission application rejected because the order has already been submitted to the bank. |
| EBICSCL2361 | Ordermetadata file is not a zip file or no files present inside the zip | Ensure that the ordermetadata file is in a compressed format and that the zip file has valid content. |
| EBICSCL2362 | Incorrect number of files present in Ordermetadata zip | Indicates that the number of files present in the ordermetadata.zip file is incorrect. For example, when submitting an FUL order type from back-end, if the zip file does not contain either the payload data or the ordermetadata.xml or both. |
| EBICSCL2363 | Missing file with name ordermetadata.xml in Ordermetadata zip | Ensure that the zip file contains a file with the name ordermetadata.xml. |
| EBICSCL2364 | Missing Payload file in Ordermetadata zip for OrderType FUL | Ensure that the zip file contains the payload order data for order type FUL. |
| EBICSCL2365 | Error while trying to retrieve Transport URL or other mandatory transport parameters | Indicates that the host URL is malformed or the client is unable to retrieve HTTP configuration details from the database. |
| EBICSCL2366 | Error while decrypting the data | An error occurred when decrypting the data. The error may be a result of, for example, encrypting the data with the wrong certificate or if the data is not complete. |
| EBICSCL2367 | Error while encrypting the data | Indicates that the key was not found. |
| EBICSCL2368 | Error while creating XML authentication | The error may be a result of , for example, certificate not configured or unable to retrieve the certificate. |
| EBICSCL2369 | Error while verifying XML authentication | The error may be a result of , for example, certificate not configured or unable to retrieve the certificate. |
| EBICSCL2370 | Unexpected Return code from Server | The server returned an error not defined in the client database. |
| EBICSCL2371 | EBICS Client Internal Error | An internal error occurred when processing an EBICS request. |
Return codes for HPB
Return Code | Event Message | Summary |
|---|---|---|
| EBICSCL1701 | EBICS HPB Request Creation Failed | An error occurred when creating an HPB request. |
| EBICSCL1702 | EBICS HPB Request Creation Passed | The HPB order request was created successfully. |
| EBICSCL1703 | EBICS HPB Response Parsing Failed | An error occurred when parsing an HPB response. |
| EBICSCL1704 | EBICS HPB Response Parsing Passed | The HPB response was parsed successfully. |
| EBICSCL1705 | EBICS HPB Response Un-Packing Passed | The HPB response was unpacked successfully. |
| EBICSCL1706 | EBICS HPB Response Un-Packing Failed | An error occurred when unpacking an HPB response. |
| EBICSCL1707 | EBICS HPB Bank Certs Save Failed | An error occurred when saving the bank keys. |
| EBICSCL1708 | EBICS HPB Bank Certs Save Pass | The HPB bank keys were saved successfully. |
Return codes for keys
Return Code | Event Message | Summary |
|---|---|---|
| EBICSCL2372 to EBICSCL2381 | Could not retrieve Private Key for usage | The following is a list of possible reasons for failure to retrieve private keys:
|
| EBICSCL2382 to EBICSCL2391 | Could not retrieve Public Key for usage | The following is a list of possible reasons for failure to retrieve public keys:
|
Return codes for generating order IDs
Return Code | Event Message | Summary |
|---|---|---|
| EBICSCL2399 | OrderID generation re-initialized | Indicates that the last three alphanumeric values in the order ID, which can range from 000 to zzz, was re-initialized to 000. |
| EBICSCL2400 | Order logging failed in the EBICS client system | The order ID already exists in the system for partner ID. Contact administrator for further action. |
| EBICSCL2401 | OrderID generation failed | In a multi-node scenario, when one of the nodes fails to refresh the order ID cache and consequently fails to generate an Order ID for a particular order. |
| EBICSCL2402 | OrderID Cache configuration error | Check the configuration for order ID cache under System Properties. |
Technical return codes
Return Code | Event Message | Summary |
|---|---|---|
| ESRVT011000 | [t011000] EBICS_DOWNLOAD_POSTPROCESS_DONE | The positive acknowledgment of the EBICS response that is sent to the client from the server. |
| ESRVT011001 | [t011001] EBICS_DOWNLOAD_POSTPROCESS_SKIPPED | The negative acknowledgment of the EBICS response that is s |