7.18.5 PayoutBySupportedAssetList Method

The PayoutBySupportedAssetList 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 57 and Table 58 specify the Arguments and AddressSpace representation, respectively.

Signature

	PayoutBySupportedAssetList (
	  [in]   0:UInt32[]             NumberOfAssetsBySupportedAssetList,
	  [out]  0:Int32                Status);
Table 57 - PayoutBySupportedAssetList Arguments
Argument Description
NumberOfAssetsBySupportedAssetListFor each entry of the SupportedAssetList, the number of assets 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

-3 = Invalid length of NumberOfAssetsBySupportedAssetList

Vendors may return a vendor specific status starting with number -16 or smaller.

Method Result Codes (defined in Call Service)

Result Code Description
Bad_UserAccessDeniedSee OPC 10000-4 for a general description.
Table 58 - PayoutBySupportedAssetList AddressSpace definition
Attribute Value
BrowseNamePayoutBySupportedAssetList
References NodeClass BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[] 0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[] 0:PropertyType0:Mandatory