BTD Order Type
BTD is an admin order type for file downloads. Using this admin order type ensures a transparent transfer of files of any BTF structure.
Access
Mailbox
Description
BTD order type is a bank-technical download order type. A user initiates a download transaction with the bank by submitting a download order request.
The BTF structure is introduced in the file name for .DAT
, .SIG
and .PRM
files.
The file naming convention for files generated in BTD is as follows:
Note: "@" is appended if the
respective attribute is not
present.
WISHBANK_SERVICENAME_SCOPE_SERVICEOPTION_CONTAINERTYPE_MSGNAME_MSGVER_MSGVAR_MSGFORMAT_*******
Example : WISHBANK_XCT_FR_@_@cfonb320@@@_R_D20210828_H030310_2F98D452E835968ED448EBE424068151.DAT
Note: PSR
files are not be generated in EBICS 3.0.
Parameters
Parameter | Description and value |
---|---|
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, BTD is the order type. |
BTF Service | The BTF Service associated with the order type. BTF Service (BTF parameters - Service Name, Service Scope, Service Option, Container Type & Message attributes ) from the table. |
DownloadDateRangeStart | The start date of the download of order data. This parameter is applicable only for BTD order type. |
DownloadDateRangeEnd | The end date of the download of order data. This parameter is applicable only for BTD order type. |
XML schema
<?xml version='1.0' encoding='UTF-8'?><orderMetaData xmlns:ns2="partnerInfo">
<PartnerID>SANPARTNER</PartnerID>
<HostID>SANBANK</HostID>
<HostUrlAlias>SANBANKURL</HostUrlAlias>
<OrderType>BTD</OrderType>
<orderTypeJsonFile>BTDTemplate</orderTypeJsonFile>
<Product>IBM EBICS Client</Product>
<productLang>EN</productLang>
<ParameterList/>
<SecurityMedium>0200</SecurityMedium>
<UserID>SANUSER10</UserID>
<serviceName>PSR</serviceName>
<serviceOptions></serviceOptions>
<serviceScope>FR</serviceScope>
<MsgNameElement>
<msgName>cfonb560</msgName>
<MessageType>
<msgVersion></msgVersion>
<msgVariant></msgVariant>
<msgFormat></msgFormat>
</MessageType>
</MsgNameElement>
<ContainerElement>
<serviceContainer>false</serviceContainer>
<ContainerFlagType>
<containerType></containerType>
</ContainerFlagType>
</ContainerElement>
<DownloadDateRangeStart>2021-06-01</DownloadDateRangeStart>
<DownloadDateRangeEnd>2021-06-25</DownloadDateRangeEnd>
</orderMetaData>