HCA order type

Use HCA order type to send amendment of the subscriber key for identification and authentication and encryption.

Access

Mailbox

Description

HCA is an upload key management order type used to update customer's certificate for identification and authentication and encryption. The order data is signed, compressed, encrypted, and base64-encoded.

Parameters

Table 1. HCA 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. The HCA 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.
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. The value cannot be changed for INI, HIA, and HPB order types. The security medium for the subscriber’s bank-technical key is set to 0000 since HPB orders neither require electronic signatures nor transmit bank-technical subscriber keys.
OrderType The order type of the order you are submitting. In this case, HCA is the order type.
UserAuthNewPubKeyAlias The alias of the new authentication public certificate to be updated for the user. The public key provided by the user to the bank to validate the authorization of the user in the request from the EBICS Client. The trading partner or user shares the key with the bank.
UserAuthNewPubKeyID The ID of the new authentication public certificate to be updated for the user.
UserAuthNewPriKeyAlias The alias of the new authentication private certificate to be updated for the user. The private key used by EBICS Client to create a digital signature for the user in the request sent to the bank. The bank must have the public part of the key to validate the authorization.
UserAuthNewPriKeyID The ID of the new authentication private certificate to be updated for the user.
UserEncrNewPubKeyAlias The alias of the new encryption public certificate to be updated for the user. The public part of the system certificate that is selected as the encryption private certificate. The trading partner or user shares the key with the bank.
UserEncrNewPubKeyID The ID of the new encryption public certificate to be updated for the user.
UserEncrNewPriKeyAlias The alias of the new encryption private certificate to be updated for the user. The private key used by EBICS Client to decrypt the response received from the bank.
UserEncrNewPriKeyID The ID of the new encryption private certificate to be updated for the user.
UserNewAuthVersion The key version of the authentication certificate is X002.
UserNewEncVersion The key version of the encryption certificate is E002.

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>UH2LCMC1</UserID>
  <SystemID>UH2LCMC1</SystemID>
  <orderIdPrefix>E</orderIdPrefix>
  <SecurityMedium>0200</SecurityMedium>
  <OrderType>HCA</OrderType>
  <UserAuthNewPubKeyAlias>CAEBAuthLMPub</UserAuthNewPubKeyAlias>
  <UserAuthNewPubKeyID>270:3290569:130ae100679:goldie:node1</UserAuthNewPubKeyID>
  <UserAuthNewPriKeyAlias>CAEBAuthLMPriv</UserAuthNewPriKeyAlias>
  <UserAuthNewPriKeyID>041:3289243:130ae100679:goldie:node1</UserAuthNewPriKeyID>
  <UserEncrNewPubKeyAlias>CAEBEncrLMPub</UserEncrNewPubKeyAlias>
  <UserEncrNewPubKeyID>694:3292683:130ae100679:goldie:node1</UserEncrNewPubKeyID>
  <UserEncrNewPriKeyAlias>CAEBEncrLMPriv</UserEncrNewPriKeyAlias>
  <UserEncrNewPriKeyID>167:3288453:130ae100679:goldie:node1</UserEncrNewPriKeyID>
  <UserNewAuthVersion>X002</UserNewAuthVersion>
  <UserNewEncVersion>E002</UserNewEncVersion>
</orderMetaData>