Sterling B2B Integrator - Configure Order Type Manager
EBICS order types specify the various transactions that can take place between an EBICS Banking Server and an EBICS Client. Each order type is based on an XML schema and caters to different requirements.
Order types are represented by a three-figure alphanumeric code that identifies the type of the order.
The following table lists the order types supported for EBICS transactions:
Order Type | Protocol Version | Description |
---|---|---|
Upload System Order Types | ||
H3K | H004 | Used to transmit all public keys (Bank Technical Key certificate, Identification and Authentication certificate, and Encryption certificate) for subscriber initialization. |
HCA | H003, H004 | Used to update a user’s certificates. Sends the following certificates for updating the EBICS Banking Server:
|
HCS | H003, H004 | Used to update a user’s certificates. Sends the following certificates for updating the EBICS Banking Server:
|
HIA | H003, H004 | Used to transmit user public certificates for identification, authentication and encryption within the framework of subscriber initialization. |
HVE | H003, H004 | Used to add the VEU signature |
HVS | H003, H004 | Used to upload a VEU cancellation |
INI | H003, H004 | Used in subscriber initialization. Sends the bank-technical public certificate of the user to the EBICS Banking Server. |
PUB | H003, H004 | Used to update user’s certificate. Sends the bank-technical public certificate of the customer for updating the EBICS Banking Server. |
SPR | H003, H004 | Used to suspend a user’s access authorization. |
CCT | H003, H004 | Used to initiate the credit transfer per Single Euro Payments Area (SEPA) specification set by the European Payment Council or Die Deutsche Kreditwirtschaft (DK (German)). |
CCU | H003, H004 | Used to initiate the credit transfer for urgent payments. |
CD1 | H003, H004 | Used to initiate a single day debit, which allows the creditor to submit the collection file one day before the collection date. |
CDD | H003, H004 | Used to initiate a direct debit transaction. |
YCT | H003, H004 | Used to upload credit transfer initiation. |
XCT | H003, H004 | Used to upload credit transfer initiation. |
YDD | H003, H004 | Used to upload direct debit initiation. |
Download System Order Types | ||
HAC | H004 | Used to download customer acknowledgment (XML format) |
HEV | H000 | Used to download information on supported EBICS versions. |
HKD | H003, H004 | Used to download customer and subscriber data. Retrieves information stored by the bank pertaining to the subscriber’s company and associated subscribers. |
HPB | H003, H004 | Used to download bank public certificates from the EBICS Banking Server. |
HPD | H003, H004 | Used to download bank parameters from the EBICS Banking Server. |
HTD | H003, H004 | Used to download customer and subscriber data. Retrieves information stored by the bank pertaining to the subscriber’s company. |
HVD | H003, H004 | Used to retrieve the VEU state |
HVT | H003, H004 | Used to retrieve VEU transaction details |
HVU | H003, H004 | Used to download a VEU overview |
HVZ | H003, H004 | Used to download a VEU overview with additional information |
CDZ | H003, H004 | Used to download the payment status report for each direct debit transaction. |
CRZ | H003, H004 | Used to download the payment status report for each credit transfer. |
VMK | H003, H004 | Used to download the short-term acknowledgement slips. |
STA | H003, H004 | Used to download the SWIFT daily accounts. |
XTX | H003, H004 | Used to download payment status report for credit transfer. |
Upload Bank-Technical Order Type | ||
FUL | H003, H004 | Used to upload file of any format. |
Download Bank-Technical Order Type | ||
FDL | H003, H004 | Used to download file of any format. |
You can add file formats and associate them with the bank-technical upload and download order types from the Administration menu.
Sterling B2B Integrator enables you to add file formats and associate them with the bank-technical upload and download order types. An order type can have zero or more file formats. The file formats for FUL and FDL are based on the SWIFTNet request type.
To create a file format, complete the following steps:
- Log in to Sterling B2B Integrator.
- From the Administration menu, select EBICS > Subscription Manager > Order Type Manager > File Format Configuration.
- In the File Format Configuration page, click Go next to Create New File Format.
- Enter the name of the file format in the File Format field. The file format can be created with any name with these two restrictions:
- The first four characters should be from a to z.
- The name should contain a dot (.).
- Select a Country Code from the Country Code drop-down list. The default value is [FR] FRANCE.
- Click Next.
- In the Confirm page, verify the file format settings, and click Finish.
You can search for a file format from under the Administration menu by name.
To search for a file format, complete the following steps:
- Log in to Sterling B2B Integrator.
- From the Administration menu, select EBICS > Subscription Manager > Order Type Manager > File Format Configuration.
- In the File Format Configuration page, perform one of the following actions, and click Go.
- Under Search in the File Format field, enter either a part of the name or the entire name of the file format you are searching for.
- From the List Alphabetically drop-down list, select ALL or the letter with which the name of the file format you are searching for begins. Selecting ALL lists all the file formats.
- Click the file format link to view the file format settings.
You can edit a file format from under the Administration menu.
To edit a file format, complete the following steps:
- Log in to Sterling B2B Integrator.
- From the Administration menu, select EBICS > Subscription Manager > Order Type Manager > File Format Configuration.
- In the File Format Configuration page, using either Search or List, locate and select the file format you want to edit, and click Go.
- Click edit next to the file format you want to edit.
- Select a Country Code from the Country Code drop-down list and click Next.
- In the Confirm page, verify the file format settings, and click Finish.
You can delete a file format from under the Administration menu.
To delete a file format, complete the following steps:
- Log in to Sterling B2B Integrator.
- From the Administration menu, select EBICS > Subscription Manager > Order Type Manager > File Format Configuration.
- In the File Format Configuration page, using either Search or List, locate and select the file format you want to delete, and click Go.
- Click delete adjacent to the file format you want to delete.
- Click Return to return to the File Format Configuration page.
EBICS order types specify the various transactions that can take place between an EBICS Banking Server and an EBICS Client. Each order type is based on an XML schema and caters to different requirements.
To search for an order type:
- Log in to Sterling B2B Integrator.
- From the Administration menu, select EBICS > Subscription Manager > Order Type Manager > Order Type Configuration.
- In the Order Type Configuration page, perform one of the following actions, and click Go.
- In the Search Order Type field, enter either a part of the name or the entire name of the order type you are searching for.
- In the Search Protocol Version field, enter either a part of the name or the entire protocol version of the order type you are searching for.
- From the List Alphabetically drop-down list, select ALL or the letter with which the name of the order type you are searching for begins. Selecting ALL lists all the order types.
- In the Order Type Settings page, click the corresponding order type to view the order type's settings. To view the list of file formats assigned to the order type in the Order Type Settings page, click Show All next to List of File Formats.
You can edit an order from under the Administration menu.
To edit an order type, complete the following steps:
- Log in to Sterling B2B Integrator.
- From the Administration menu, select EBICS > Subscription Manager > Order Type Manager > Order Type Configuration.
- In the Order Type Configuration page, using either Search or List, locate and select the order type you want to edit, and click Go.
- Click edit next to the order type you want to edit.Click the order type to view the order type settings.Note: You can edit only the bank-technical order types, FUL and FDL.
- In the Order Type page, review the order type settings listed in the following table and click Next.FieldDescription
Order Type The order type present in the system, for example, FDL. Protocol Version Schema version relevant for the supported EBICS version, for example, H003. Release Version EBICS version supported by the bank, for example, 02.40. Description Textual description of the order type, for example, Download file with any format. Transfer Type Transfer type can be one of the following: - Upload = Upload order data from EBICS client to EBICS server
- Download = Download order data from EBICS server to EBICS client
Order Data Type Order data type can be one of the following: - System = System order type
- Technical = Technical order type
- The file formats and the corresponding country codes associated with th