SPR order type

Use the SPR order type to suspend a user's access authorization.




SPR is an upload key management order type. A subscriber can be suspended from transacting further with the bank for several reasons. One of the primary reasons for suspending a user is if the subscriber keys are compromised. If there is any suspicion that the subscriber keys are compromised, the subscriber must immediately suspend their access authorization to all the bank systems that use the keys.

The SPR order type does not compromise any additional order data and therefore does not contain any order file. The electronic signature of the EBICS Client user who is to be suspended is sent to the bank. The order data is a blank character. The signature is compressed, encrypted, and base64 encoded similar to a standard upload transaction.

Once a subscriber is suspended from transacting with the bank, the subscriber has to submit a new set of INI and HIA order types to the bank. If a subscriber is suspended by the bank, initialization through INI and HIA is not possible. Only the bank can revoke the suspension.


Table 1. SPR 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 SPR 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.
OrderType The order type of the order you are submitting. In this case, SPR is the order type.

XML schema

<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"