HKD order type
Using the HKD order type, the user can download customer data and subscriber data.
Access
Mailbox
Description
HKD is a download key management order type. Use the HKD order type to download information about a partner and associated subscribers stored by the bank, including information about your own company. The order data is compressed and base64-encoded.
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, HKD is the order type. |
XML schema
<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData>
<HostID>BNKLCMC1</HostID>
<HostUrlAlias>BNKLCMC1_URL_ALIAS</HostUrlAlias>
<PartnerID>PH2LCMC1</PartnerID>
<UserID>USERPK12</UserID>
<SystemID>UH2LCMC1</SystemID>
<orderIdPrefix>H</orderIdPrefix>
<SecurityMedium>0200</SecurityMedium>
<OrderType>HKD</OrderType>
</orderMetaData>