7.18.4 PayoutByValue Method
The PayoutByValue Method triggers a 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 does not indicate, that the payout has been completed successful. Clients need to access the PayoutStatus Variable to get the information, if the payout gets successfully finished.
The signature of this Method is specified below. Table 55 and Table 56 specify the Arguments and AddressSpace representation, respectively.
Signature
PayoutByValue (
[in] PriceDataType PayoutValue,
[out] 0:Int32 Status);| Argument | Description |
| PayoutValue | The value to be paid out. |
| Status | Status of the execution of the method. If issues occurred during execution. 0 = Execution was successful. -1 = Cannot trigger payout as another payout is ongoing -2 = Cannot trigger payout, not enough assets left 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 | PayoutByValue | ||||
| 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 |