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.

Table 1. Return codes for events
Return Code
Event Message
Description
EBICSCL2302Order Data CompressedIndicates that the order data of the transaction is compressed. No action required.
EBICSCL2303Order Data EncryptedIndicates that the order data of the transaction is encrypted. No action required.
EBICSCL2304Order Data EncodedIndicates that the order data of the transaction is encoded. No action required.
EBICSCL2305Order Data SignedIndicates that the order data of the transaction is signed. No action required.
EBICSCL2306Order Data DecompressedIndicates that the order data of the transaction is decompressed. No action required.
EBICSCL2307Order Data DecryptedIndicates that the order data of the transaction is decrypted. No action required.
EBICSCL2308Order Data DecodedIndicates that the order data of the transaction is decoded. No action required.
EBICSCL2309Signature Data CompressedIndicates that the signature data of the transaction is compressed. No action required.
EBICSCL2310Signature Data EncryptedIndicates that the signature data of the transaction is encrypted. No action required.
EBICSCL2311Signature Data EncodedIndicates that the signature data of the transaction is encoded. No action required.
EBICSCL2312Signature Data DecompressedIndicates that the signature data of the transaction is decompressed. No action required.
EBICSCL2313Signature Data DecryptedIndicates that the signature data of the transaction is decrypted. No action required.
EBICSCL2314Signature Data DecodedIndicates that the signature data of the transaction is decoded. No action required.
EBICSCL2300EBICS Packaging PassedIndicates that the packaging of the order data was successful. No action required.
EBICSCL2301EBICS Packaging FailedIndicates 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.
EBICSCL2500EBICS Unpackaging PassedIndicates that the unpackaging of the order data was successful. No action required.
EBICSCL2501EBICS Unpackaging FailedIndicates 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.
EBICSCL2318Valid Response ReceivedIndicates that you have received a valid response from the server when you submit an order type.
EBICSCL2319Erroneous Response ReceivedIndicates 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.
EBICSCL2320EBICS Initialisation Request PassedIndicates that the request has been initialized.
EBICSCL2321EBICS Data Transfer Request PassedIndicates that the request for transfer of data has been accepted by the bank.
EBICSCL2322No Submitter AuthorityIndicates 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.
EBICSCL2323Unpackaged data writing to Mailbox successIndicates that the data was unpackaged and stored in the user mailbox.
EBICSCL2324Unpackaged data writing to Mailbox failureThe 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.
EBICSCL2325Pending Tasks created for AuthorizersIndicates that pending tasks are created for the user. View the list of pending tasks to be signed using the EBICS Client dashboard interface.
EBICSCL2326Pending Tasks created for SubmitterIndicates 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.
EBICSCL2327Signature generation successful for AuthorizerIndicates that the signature generation was successful when a signatory signed an order that was pending for signature.
EBICSCL2328Signature generation failed for AuthorizerIndicates that the signature generation was unsuccessful when a signatory signed an order that was pending for signature.
EBICSCL2329OrderType is invalidIndicates that the order type specified is invalid. Specify a valid order type.
EBICSCL2330HostID is invalidIndicates that the host ID or the bank ID specified is invalid. Specify a valid host ID.
EBICSCL2331PartnerID and UserID combination is invalidIndicates that the user ID and the associated partner ID combination is invalid. Specify a valid combination of user ID and associated partner ID.
EBICSCL2332SystemID is invalidIndicates that the system ID specified is invalid. Specify a valid system ID.
EBICSCL2333Missing mandatory parameter in order metadataIndicates 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.
EBICSCL2334Security Medium is invalidIndicates that the value specified for security medium is not valid. Enter a four-digit security number in the 0100 – 0499 range.
EBICSCL2335Unable to parse Primary Document in WorkflowRe-check configuration and initiate transaction.
EBICSCL2336Encryption Public Key not found for BankUpload a valid encryption key.
EBICSCL2337Could not retrieve Key for usageWhen signing or encrypting order data, the key to the alias could not be retrieved.
EBICSCL2338Segment Upload to HostThe order data segment was successfully uploaded to the server.
EBICSCL2339Segment Download from HostThe order data segment was successfully downloaded from the server.
EBICSCL2340Calculated Total Number of segments to be UploadedEBICS Client calculates the total number of segments of an order data that is to be uploaded.
EBICSCL2341Got Total Number of segments to be DownloadedEBICS Client receives the total number of segments of an order data that is to be downloaded.
EBICSCL2342Auto Submit value is invalidIndicates 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.
EBICSCL2343Country code value is invalidIndicates that the abbreviation for a country is not valid. Specify a valid format for country abbreviations.
EBICSCL2344Host not yet ActiveIndicates that the server at the bank is not yet active. Download the bank keys using the HPB order type and validate the bank keys.
EBICSCL2345User not yet ReadyIndicates 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.
EBICSCL2346Response data writing to Mailbox successIndicates that the response received from the bank was successfully stored in the mailbox.
EBICSCL2347Response data writing to Mailbox failureThe 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.
EBICSCL2348Error putting message into MailboxIndicates that the message could not be uploaded to the mailbox.
EBICSCL2349No Response from ServerIndicates that the server did not respond when a request was sent to the server.
EBICSCL2350Invalid response from ServerIndicates that the server returned an invalid response when a request was sent to the server.
EBICSCL2392Mandatory Parameter for HttpClient missingIndicates 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.
EBICSCL2393HttpClient Instance Not FoundIndicates that the http client adapter instance is missing.
EBICSCL2394Error in Ending HTTP Session with ServerIndicates that an error occurred when ending the HTTP session with the server, which may be a result of not finding a valid session.
EBICSCL2395Host Not FoundIndicates that the host or port is not configured properly.
EBICSCL2396Handshake FailureWhen connecting to the server using SSL. the connection may be unsuccessful, for example, because of invalid certificates.
EBICSCL2398Could not complete connection to specified hostIndicates that the client was unable to connect to a host even when the session was successfully started.
EBICSCL2351Invalid key length for signatureIndicates 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.5.

EBICSCL2352Invalid key length for authenticationIndicates 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.5.

EBICSCL2353Invalid key length for encryptionIndicates 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.5.

EBICSCL2354Error in starting HTTP Session with ServerIndicates that an error occurred when starting an HTTP session with the server.
EBICSCL2355Error in parsing OrderMetadata Document with Message IDCheck whether the XML is well-formed or not.
EBICSCL2356Technical Subscriber does not have permissions to be a delegate of the User specifiedConfigure technical user and associate the technical user with an existing user.
EBICSCL2357Error while trying to retrieve message from MailboxIndicates that an error occurred when retrieving a message from the mailbox.
EBICSCL2358Error in parsing OrderMetadata DocumentCheck whether the XML is well-formed.
EBICSCL2359Signature Application RejectedSignature application rejected because the signature requirements were already met for the order.
EBICSCL2360Submission Application RejectedSubmission application rejected because the order has already been submitted to the bank.
EBICSCL2361Ordermetadata file is not a zip file or no files present inside the zipEnsure that the ordermetadata file is in a compressed format and that the zip file has valid content.
EBICSCL2362Incorrect number of files present in Ordermetadata zipIndicates 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.
EBICSCL2363Missing file with name ordermetadata.xml in Ordermetadata zipEnsure that the zip file contains a file with the name ordermetadata.xml.
EBICSCL2364Missing Payload file in Ordermetadata zip for OrderType FULEnsure that the zip file contains the payload order data for order type FUL.
EBICSCL2365Error while trying to retrieve Transport URL or other mandatory transport parametersIndicates that the host URL is malformed or the client is unable to retrieve HTTP configuration details from the database.
EBICSCL2366Error while decrypting the dataAn error occurred when decrypting the data. This can be caused by many things. For example, The data being encrypted with the wrong certificate or incomplete encrypted data could cause this error.
EBICSCL2367Error while encrypting the dataAn error occurred when encrypting the data. This can be caused by many things. For example, an invalid or missing key could cause this error.
EBICSCL2368Error while creating XML authenticationThe error may be a result of , for example, certificate not configured or unable to retrieve the certificate.
EBICSCL2369Error while verifying XML authenticationThe error may be a result of , for example, certificate not configured or unable to retrieve the certificate.
EBICSCL2370Unexpected Return code from ServerThe server returned an error not defined in the client database.
EBICSCL2371EBICS Client Internal ErrorAn internal error occurred when processing an EBICS request.
EBICSCL2403NIST compliance errorNIST compliance error. Please check whether the algorithm/keystrength being used is NIST compliant in the current configured NIST compliance mode.
EBICSCL2404Signature certificate not issued by a CASignature certificate not issued by a certification authority (CA). IssuerDN: ${0}.
EBICSCL2405EBICS Protocol version mismatch, server replies with different version than order type is offered forEBICS Protocol version mismatch, OrderType INI offered for H003 but the EBICS server sent a response for protocol version H004.

Return codes for HPB

Table 2. Return codes for HPB
Return Code
Event Message
Description
EBICSCL1701EBICS HPB Request Creation FailedAn error occurred when creating an HPB request.
EBICSCL1702EBICS HPB Request Creation PassedThe HPB order request was created successfully.
EBICSCL1703EBICS HPB Response Parsing FailedAn error occurred when parsing an HPB response.
EBICSCL1704EBICS HPB Response Parsing PassedThe HPB response was parsed successfully.
EBICSCL1705EBICS HPB Response Un-Packing PassedThe HPB response was unpacked successfully.
EBICSCL1706EBICS HPB Response Un-Packing FailedAn error occurred when unpacking an HPB response.
EBICSCL1707EBICS HPB Bank Certs Save FailedAn error occurred when saving the bank keys.
EBICSCL1708EBICS HPB Bank Certs Save PassThe HPB bank keys were saved successfully.

Return codes for keys

Table 3. Return codes for keys
Return Code
Event Message
Description
EBICSCL2372 to EBICSCL2381Could not retrieve Private Key for usageThe following is a list of possible reasons for failure to retrieve private keys:
  • SystemCertificate not found in Database
  • Certificate is Expired
  • Certificate Not Yet Valid
  • Certificate is Held
  • Certificate is Revoked
  • Invalid Issuer Signature for a certificate in the chain
  • CertPathValidation failed
  • Error in Certificate
  • Error in fetching Certificate
  • Error in fetching key from RSA KeyStore
EBICSCL2382 to EBICSCL2391Could not retrieve Public Key for usageThe following is a list of possible reasons for failure to retrieve public keys:
  • Key not found in Database
  • Certificate is Expired
  • Certificate Not Yet Valid
  • Certificate is Held
  • Certificate is Revoked
  • Invalid Issuer Signature for a certificate in the chain
  • CertPathValidation failed
  • Error in Certificate
  • Error in fetching Certificate
  • Error in fetching key from RSA KeyStore

Return codes for generating order IDs

Table 4. Return codes for generating order IDs
Return Code
Event Message
Description
EBICSCL2399OrderID generation re-initializedIndicates that the last three alphanumeric values in the order ID, which can range from 000 to zzz, was re-initialized to 000.
EBICSCL2400Order logging failed in the EBICS client systemThe order ID already exists in the system for partner ID. Contact administrator for further action.
EBICSCL2401OrderID generation failedIn 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.
EBICSCL2402OrderID Cache configuration errorCheck the configuration for order ID cache under System Properties.

Technical return codes

Table 5. Technical return codes
Return Code