7.19 PaymentBillDeviceType definition
7.19.1 Overview
The PaymentBillDeviceType provides information about a payment device taking bills or token. It is formally defined in Table 61.
7.19.2 ObjectType definition
| Attribute | Value | ||||
| BrowseName | PaymentBillDeviceType | ||||
| IsAbstract | False | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the PaymentCashDeviceType | |||||
| 0:HasComponent | Method | CancelPayout | M | ||
| 0:HasComponent | Variable | CurrentValueInEscrow | 0:UInt32 | 0:BaseDataVariableType | M |
| 0:HasComponent | Method | HandleBillFromEscrow | M | ||
| Conformance Units | |||||
|---|---|---|---|---|---|
| UnattendedRetail PaymentDevice Bill | |||||
The CurrentValueInEscrow Variable indicates the asset currently in the escrow by pointing to the index of the SupportedAssetList.
7.19.3 CancelPayout Method
The CancelPayout Method cancels the current payout.
If the execution of the Method cannot be done due to some application logic, the Method should return an Uncertain StatusCode and provide details of the failure in the Status output Argument. When the Method returns an Uncertain StatusCode, the Method is considered to be failed.
If the Method returns successful, it indicates, that the current payout has been cancelled and will not continue.
The signature of this Method is specified below. Table 62 and Table 63 specify the Arguments and AddressSpace representation, respectively.
Signature
CancelPayout (
[out] 0:Int32 Status);| Argument | Description |
| Status | Status of the execution of the method. If issues occurred during execution. 0 = Execution was successful. -1 = No payout ongoing that can be cancelled Vendors may return a vendor specific status starting with number -16 or smaller. |
Method Result Codes (defined in Call Service)
| Result Code | Description |
| Bad_UserAccessDenied | See OPC 10000-4 for a general description. |
| Attribute | Value | ||||
| BrowseName | CancelPayout | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
7.19.4 HandleBillFromEscrow Method
The HandleBillFromEscrow Method defines what the payment device shall do with the bill or token currently stored in the escrow.
If the execution of the Method cannot be done due to some application logic, the Method should return an Uncertain StatusCode and provide details of the failure in the Status output Argument. When the Method returns an Uncertain StatusCode, the Method is considered to be failed.
If the Method returns successful, it does not indicate, that the bill or token was already processed completely from the escrow. Clients need to access the CurrentValueInEscrow Variable to get the information, if the bill or token has successfully been moved.
The signature of this Method is specified below. Table 64 and Table 65 specify the Arguments and AddressSpace representation, respectively.
Signature
HandleBillFromEscrow (
[in] 0:Boolean AcceptBill,
[out] 0:Int32 Status);| Argument | Description |
| AcceptBill | If true, the current bill or token in escrow (see Variable CurrentValueInEscrow) gets accepted, if false, it gets rejected. The place where the bill or token is moved to in case of it gets accepted is defined in the AssetConfigurationList. |
| Status | Status of the execution of the method. If issues occurred during execution. 0 = Execution was successful. -1 = Currently no bill in escrow Vendors may return a vendor specific status starting with number -16 or smaller. |
Method Result Codes (defined in Call Service)
| Result Code | Description |
| Bad_UserAccessDenied | See OPC 10000-4 for a general description. |
| Attribute | Value | ||||
| BrowseName | HandleBillFromEscrow | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| 0:HasProperty | Variable | 0:InputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |
| 0:HasProperty | Variable | 0:OutputArguments | 0:Argument[] | 0:PropertyType | 0:Mandatory |