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
| |
---|
HostID | The 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. |
HostUrlAlias | When 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. |
PartnerID | The partner ID associated with the user ID. |
UserID | Unique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard. |
SystemID | User 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. |
SecurityMedium | A 4-digit security number in the 0000 to 0499 range. |
OrderType | The order type of the order you are submitting. In this case, FDL is the order type. |
FileFormat | The 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. |
DownloadDateRangeStart | The start date of the download of order data. This parameter is applicable only for FDL order type. |
DownloadDateRangeEnd | The 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>