HVS order type

Using the HVS order type, the user can permanently cancel an existing order from VEU/EDS processing.

Access

Mailbox

Description

HVS is an upload order type for distributed signature. Use the HVS order type to permanently cancel an existing order from VEU/EDS processing. The subscriber sends an HVS request to cancel an order and delivers the bank-technical signature required for cancellation through the hash value of the order data. The HVS response does not contain any VEU/EDS specific data.

Note: For EBICS 3.0 and later versions, VEU is referred to as EDS.

Parameters

Table 1. HVS parameters
Parameter	Description and value
PartnerID	The partner ID associated with the user ID.
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.
OrderType	The order type of the order you are submitting. In this case, HVS is the order type.
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.
Product	The product for the EBICS Client application.
productLang	The language setting of the EBICS Client application that you are using. For example, specify EN if the language is set to English.
SecurityMedium	A 4-digit security number in the 0000 to 0499 range.
UserID	Unique ID of the user in the bank's system, which corresponds to the user created in the EBICS Client dashboard.
OrigPartnerID	The Partner ID associated with the user who submitted the upload order type.
OrigOrderID	The order ID of the order for which the signature is applied.
OrigOrderType	The order type of the order for which the signature is applied.
VeuMessageDigest	Specify the Message Digest to submit the hash value of the order data. You can request for the hash value by calling or mailing the bank. The bank sends the hash value of the order data through an alternate mode of communication, for example, email.
PAYLOADMSGID	Specify a ID for the payload message to submit the complete payload from your mailbox. You can request for the payload by calling or mailing the bank. The bank sends the payload to your EBICS Client mailbox.
VEUOrderSeqID	The sequence ID of the transaction assigned by the client for which you are applying the signature using HVS.

XML schema

The following XML schema illustrates the use of HVS using VEU/EDS message digest:

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="new_omd.xsd">
	<PartnerID>PARTNERPK55</PartnerID>
	<HostID>HOSTBNKPK12</HostID>
	<HostUrlAlias>HOSTBNKPK12_URL_ALIAS</HostUrlAlias>
	<OrderType>HVS</OrderType>
	<orderIdPrefix>V</orderIdPrefix>
	<Product>IBM EBICS Client</Product>
	<productLang>EN</productLang>
	<SecurityMedium>0200</SecurityMedium>
	<UserID>USERPK55</UserID>
	<OrigPartnerID>PARTNERPK56</OrigPartnerID>
	<OrigOrderID>V234</OrigOrderID>
	<OrigOrderType>C2X</OrigOrderType>
	<VeuMessageDigest>uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek=</VeuMessageDigest>
</orderMetaData>

The following XML schema illustrates the use of HVS using payload message ID when the entire payload is available in the mailbox:

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="new_omd.xsd">
	<PartnerID>PARTNERPK55</PartnerID>
	<HostID>HOSTBNKPK12</HostID>
	<HostUrlAlias>HOSTBNKPK12_URL_ALIAS</HostUrlAlias>
	<OrderType>HVS</OrderType>
	<orderIdPrefix>V</orderIdPrefix>
	<Product>IBM EBICS Client</Product>
	<productLang>EN</productLang>
	<SecurityMedium>0200</SecurityMedium>
	<UserID>USERPK55</UserID>
	<PAYLOADMSGID>71</PAYLOADMSGID>
	<OrigPartnerID>PARTNERPK56</OrigPartnerID>
	<OrigOrderID>V568</OrigOrderID>
	<OrigOrderType>C2S</OrigOrderType>
</orderMetaData>

The following XML schema illustrates the use of HVS using VEU/EDS order sequence ID. The order details are retrieved from the bank using VEU download order types before applying HVS:

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData>
	<OrderType>HVS</OrderType>
	<SecurityMedium>0200</SecurityMedium>
	<VEUOrderSeqID>39132G7e0939003jfj34535536657</VEUOrderSeqID>
	<orderIdPrefix>V</orderIdPrefix>
</orderMetaData>