Sterling B2B Integrator - Order types

A brief description of the order type, definition of the parameters defined for the order type, and the sample XML schema are provided for the following order types.

FUL is a standard order type for submitting the files to the bank. Using this order type ensures a transparent transfer of files of any format.

Access

Mailbox

Description

A user initiates a upload transaction with the bank by submitting a upload (FUL) order request. FUL order type is a bank-technical download order type.

Attention: If you upload a large number of large payload (e.g. 200 MB) data to the EBICS Server using the FUL order type, the Initialize new HTTP session for each request parameter in the EBICS Client system properties should be set to true. To modify system properties, see Updating System Property Values.

Parameters

Table 1. FUL parameters
Parameter
Description and value
HostIDThe bank ID or the host ID of the bank to which the EBICS Client user submitted the order. It is a unique ID for the bank in the bank's system.
HostUrlAliasWhen configuring a bank profile, you can specify multiple host URLs and set one host URL as the default. If you want to send a request to a host URL that is not the default URL, then, specify a value for this parameter.
PartnerIDThe partner ID associated with the user ID.
UserIDUnique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard.
SystemIDUser ID of the technical user. A technical user is a delegate of the non-technical or human user.
orderIdPrefix

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 according to 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 parameter is used with EBICS protocol version H003 only.

SecurityMediumA 4-digit security number in the 0000 to 0499 range.
OrderTypeThe order type of the order you are submitting. In this case, FUL is the order type.
FileFormatThe file format associated with the order type. An order type can have zero or more file formats. The file formats for FUL and FDL order types are based on the SWIFTNet request type.
autoSubmitThis parameter is applicable only for FUL order type. If this parameter is set to true, then an order is automatically submitted after the required number of signatures are obtained. If this parameter is set to false, 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.

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="new_omd.xsd">
<HostID>SUBNKPK12</HostID>
<HostUrlAlias>SUBNKPK12_URL_ALIAS</HostUrlAlias>
<PartnerID>SUPKID</PartnerID>
<UserID>SUUSER1</UserID>
<SystemID>TECHUSER</SystemID>
<orderIdPrefix>L</orderIdPrefix>
<SecurityMedium>0200</SecurityMedium>
<OrderType>FUL</OrderType>
<FileFormat>pain.xxx.cfonb160.dtg</FileFormat>
<autoSubmit>true</autoSubmit>
</orderMetaData>

Parameter List

The EBICS - Implementation Guide in France recommends that a test of the file transfer is necessary before transferring the actual files to the bank. Therefore, the customer workstation must have a set-up that allows transfer of files in a test as well as a production environment. To distinguish the test files from the production files, the parameter name TEST is included in the OrderParams tag for FUL and FDL order types. The OrderParams tag can be set in the orderMetaData XML. Similarly, the bank and the EBICS client can share a list of parameters and corresponding values based on a mutual understanding of the parameters defined in the contractual agreement.

The following example illustrates a scenario wherein test files are transferred and therefore the value of TEST is set to TRUE:

<OrderParams>
<ParameterList>
<Parameter>
<Name>TEST</Name>
<Value>TRUE</Value>
</Parameter>
<Parameter>
<Name>param2</Name>
<Value>value2</Value>
</Parameter>
<Parameter>
<Name>param3</Name>
<Value>value3</Value>
</Parameter>
</ParameterList>
</OrderParams>

 

FDL is a standard order type for file downloads. Using this order type ensures a transparent transfer of files of any format.

Access

Mailbox

Description

FDL order type is a bank-technical download order type. A user initiates a download transaction with the bank by submitting a download (FDL) order request.

Parameters

Table 1. FDL parameters
Parameter
Description and value
HostIDThe bank ID or the host ID of the bank to which the EBICS Client user submitted the order. It is a unique ID for the bank in the bank's system.
HostUrlAliasWhen configuring a bank profile, you can specify multiple host URLs and set one host URL as the default. If you want to send a request to a host URL that is not the default URL, then, specify a value for this parameter.
PartnerIDThe partner ID associated with the user ID.
UserIDUnique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard.
SystemIDUser ID of the technical user. A technical user is a delegate of the non-technical or human user.
orderIdPrefix

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 parameter is used with EBICS protocol version H003 only.

SecurityMediumA 4-digit security number in the 0000 to 0499 range.
OrderTypeThe order type of the order you are submitting. In this case, FDL is the order type.
FileFormatThe file format associated with the order type. An order type can have zero or more file formats. The file formats for FUL and FDL order types are based on the SWIFTNet request type.
DownloadDateRangeStartThe start date of the download of order data. This parameter is applicable only for FDL order type.
DownloadDateRangeEndThe end date of the download of order data. This parameter is applicable only for FDL order type.

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="new_omd.xsd">
<HostID>BNKLCMC1</HostID>
<HostUrlAlias>BNKLCMC1_URL_ALIAS</HostUrlAlias>
<PartnerID>PH2LCMC1</PartnerID>
<UserID>USERPK12</UserID>
<SystemID>UH2LCMC1</SystemID>
<orderIdPrefix>U</orderIdPrefix>
<SecurityMedium>0000</SecurityMedium>
<OrderType>FDL</OrderType>
<FileFormat>pain.002.001.02.ack</FileFormat>
<DownloadDateRangeStart></DownloadDateRangeStart>
<DownloadDateRangeEnd></DownloadDateRangeEnd>
</orderMetaData>

Parameter List

The EBICS - Implementation Guide in France recommends that a test of the file transfer is necessary before transferring the actual files to the bank. Therefore, the customer workstation must have a set-up that allows transfer of files in a test as well as a production environment. To distinguish the test files from the production files, the parameter name TEST is included in the OrderParams tag for FUL and FDL order types. The OrderParams tag can be set in the orderMetaData XML. Similarly, the bank and the EBICS client can share a list of parameters and corresponding values based on a mutual understanding of the parameters defined in the contractual agreement.

The following example illustrates a scenario wherein test files are transferred and therefore the value of TEST is set to TRUE:
<OrderParams>
<ParameterList> <Parameter>
<Name>TEST</Name>
<Value>TRUE</Value>
</Parameter> <Parameter>
<Name>param2</Name>
<Value>value2</Value>
</Parameter> <Parameter>
<Name>param3</Name>
<Value>value3</Value>
</Parameter> </ParameterList>
</OrderParams>

EBICS Client user shares the public keys for Electronic Signature with the bank through the INI (Initialization) order type.

Access

Mailbox

Description

INI is an upload key management order type. INI is used in subscriber initialization. Use INI to send the bank-technical public certificate of a customer to the bank. The order data is compressed and base64-encoded.

Self-signed certificates cannot be used for electronic signatures and consequently for user initialization (INI order type). An EBICS Client user using self-signed certificates for identification and authentication and encryption, has to use CA certificates for electronic signatures.

Parameters

Table 1. INI parameters
Parameter
Description and value
HostIDThe bank ID or the host ID of the bank to which the EBICS Client user submitted the order. It is a unique ID for the bank in the bank's system.
HostUrlAliasWhen configuring a bank profile, you can specify multiple host URLs and set one host URL as the default. If you want to send a request to a host URL that is not the default URL, then, specify a value for this parameter.
PartnerIDThe partner ID associated with the user ID.
UserIDUnique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard.
SystemIDUser ID of the technical user. The INI order type can be submitted by a technical user who is a delegate of the non-techncial or human user. Hence, the value of the UserID is the same as the value of the systemID.
orderIdPrefixEBICS 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 parameter is used with EBICS protocol version H003 only.

SecurityMediumA 4-digit security number in the 0100 to 0499 range. The value cannot be changed for INI, HIA, and HPB order types.
OrderType

The order type of the order you are submitting. In this case, INI is the order type.

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="new_omd.xsd">
<HostID>SUBNKPK12</HostID>
<HostUrlAlias>SUBNKPK12_URL_ALIAS</HostUrlAlias>
<PartnerID>SUPKID</PartnerID>
<UserID>TECHUSER</UserID>
<SystemID>TECHUSER</SystemID>
<orderIdPrefix>S</orderIdPrefix>
<SecurityMedium>0200</SecurityMedium>
<OrderType>INI</OrderType>
</orderMetaData>

EBICS Client user shares the public keys for identification and authentication and encryption with the bank through the HIA order type.

Access

Mailbox

Description

HIA is an upload key management order type. HIA is used to transmit user public certificates for identification and authentication, and encryption to enable the user to initiate transactions with the bank. The order data is compressed and base64-encoded.

Parameters

Table 1. HIA parameters
Parameter
Description and value
HostIDThe bank ID or the host ID of the bank to which the EBICS Client user submitted the order. It is a unique ID for the bank in the bank's system.
HostUrlAliasWhen configuring a bank profile, you can specify multiple host URLs and set one host URL as the default. If you want to send a request to a host URL that is not the default URL, then, specify a value for this parameter.
PartnerIDThe partner ID associated with the user ID.
UserIDUnique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard.
SystemIDUser ID of the technical user. The HIA order type can be submitted by a technical user who is a delegate of the non-techncial or human user. Hence, the value of the UserID is the same as the value of the systemID.
orderIdPrefixEBICS 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 parameter is used with EBICS protocol version H003 only.

SecurityMediumA 4-digit security number in the 0100 to 0499 range. The value cannot be changed for INI, HIA, and HPB order types.
OrderTypeThe order type of the order you are submitting. In this case, HIA is the order type.

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="new_omd.xsd">
<HostID>SUBNKPK12</HostID>
<HostUrlAlias>SUBNKPK12_URL_ALIAS</HostUrlAlias>
<PartnerID>SUPKID</PartnerID>
<UserID>TECHUSER</UserID>
<SystemID>TECHUSER</SystemID>
<orderIdPrefix>W</orderIdPrefix>
<SecurityMedium>0000</SecurityMedium>
<OrderType>HIA</OrderType>
</orderMetaData>

You can use the H3K order type to share the public certificates for Electronic Signature, identification and authentication, and encryption with the bank.

Access

Mailbox

Description

H3K is an upload key management order type. H3K is used to transmit user public certificates for Electronic Signature, identification and authentication, and encryption to enable the user to initiate transactions with the bank.

Parameters

Table 1. H3K parameters
Parameter
Description and value
HostIDThe bank ID or the host ID of the bank to which the EBICS Client user submitted the order. It is a unique ID for the bank in the bank's system.
HostUrlAliasWhen configuring a bank profile, you can specify multiple host URLs and set one host URL as the default. If you want to send a request to a host URL that is not the default URL, then, specify a value for this parameter.
PartnerIDThe partner ID associated with the user ID.
UserIDUnique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard.
SystemIDUser ID of the technical user. The H3K order type can be submitted by a technical user who is a delegate of the non-techncial or human user. Hence, the value of the UserID is the same as the value of the SystemID.
SecurityMediumA 4-digit security number in the 0000 to 0499 range.
OrderTypeThe order type of the order you are submitting. In this case, H3K is the order type.

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:ns2="partnerInfo">
<HostID>SUBNKPK12</HostID>
<HostUrlAlias>SUBNKPK12_URL_ALIAS</HostUrlAlias>
<PartnerID>SUPKID</PartnerID>
<UserID>TECHUSER</UserID>
<SystemID>TECHUSER</SystemID>
<SecurityMedium>0200</SecurityMedium>
<OrderType>H3K</OrderType>
</orderMetaData>