HVT order type
Using the HVT order type, the user can retrieve detailed information about an order from VEU/EDS processing for which the user is authorized as a signatory.
Access
Mailbox
Description
HVT is a download order type for distributed signature. Use the HVT order type to retrieve transaction details about an order from VEU/EDS processing.
For EBICS v3.0 and later versions, VEU is referred to as EDS.
Parameters
| Parameter | Description and value |
|---|---|
| OrderType | The order type of the order you are submitting. In this case, HVT is the order type. |
| SecurityMedium | A 4-digit security number in the 0000 to 0499 range. |
| VEUOrderSeqID | The sequence ID of the transaction for which you are downloading transaction details using HVT. EBICS Client assigns a sequence ID to a transaction. |
| 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. |
| completeOrderData | If the completeOrderData attribute is set to true, the user sends a request to receive the complete order file. If the completeOrderData attribute is set to false, the user sends a request to receive specific details, such as, account details, implementation deadline, amount, and other description. |
| fetchLimit | Maximum number of order details to be transmitted if the completeOrderData attribute is set to false. The default value is 100. Valid value is any non-negative integer. Specify 0 to fetch unlimited number of details. While it is possible to retrieve more than 100 details at a time, it is not ideal. |
| fetchOffset | The offset position in the original order file that marks the starting point of the transaction details to be transmitted. If the completeOrderData attribute is set to false, then the offset position applies to the sequential number of a particular order. The default value is 0. Valid value is any non-negative integer. To retrieve more than 100 records, set fetch offset as 0 to retrieve the first 100 records, then set fetch offset as 101 to retrieve the next 100 records. Continue as needed. |
XML schema
The following sample XML demonstrates the use of HVT order type when the completeOrderData
attribute is set to true:
<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData>
<OrderType>HVT</OrderType>
<SecurityMedium>0200</SecurityMedium>
<VEUOrderSeqID>39132G7e0939003jfj34535536657</VEUOrderSeqID>
<orderIdPrefix>V</orderIdPrefix>
<completeOrderData>true</completeOrderData>
</orderMetaData>The following sample XML demonstrates the use of HVT order type when the completeOrderData
attribute is set to false:
<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData>
<OrderType>HVT</OrderType>
<SecurityMedium>0200</SecurityMedium>
<VEUOrderSeqID>39132G7e0939003jfj34535536657</VEUOrderSeqID>
<orderIdPrefix>V</orderIdPrefix>
<completeOrderData>false</completeOrderData>
<fetchLimit>5</fetchLimit>
<fetchOffset>2</fetchOffset>
</orderMetaData>