4.6 WFS_CMD_CDM_CASH_IN

Description This command is not used for ATMs; there are two possibilities for use of this API.

The amount to be deposited is expressed in minimum dispense units; see WFS_INF_CDM_CURRENCY_EXP. It affects the teller counters only. The input parameters cCurrencyID and ulAmount are required as input.

If the hardware is capable of identifying the currency and the denomination of the amount deposited, the output parameters cCurrencyID, ulAmount, lpulValues, and ulCashBox will be returned.

If the hardware is equipped with refill containers the amount cashed in is simply placed on top of the cash already in the refill containers. The input parameters cCurrencyID, ulAmount and lpulValues are required.

Input Param LPWFSCDMCASHIN lpCashIn;

typedef struct _wfs_cdm_cashin
{
USHORT usTellerID;
LPWFSCDMDENOMINATION lpDenomination;
} WFSCDMCASHIN, * LPWFSCDMCASHIN;

usTellerID
Identification of Teller.

lpDenomination
Pointer to a WFSCDMDENOMINATION structure, describing the denomination of the cash in operation. For a description of the WFSCDMDENOMINATION structure see the definition of the WFS_CMD_CDM_DENOMINATE function.

Output Param LPWFSCDMDENOMINATION lpDenomination;
For a description of the WFSCDMDENOMINATION structure see the definition of the command WFS_CMD_CDM_DENOMINATE.

Error Codes The following additional error codes can be generated by this command:

Value Meaning

WFS_ERR_CDM_EXCHANGEACTIVE The CDM service is in an exchange state (see WFS_CMD_CDM_START_EXCHANGE).

WFS_ERR_CDM_INVALIDCURRENCY Specified currency not currently available

WFS_ERR_CDM_INVALIDTELLERID Teller ID not present in service provider’s teller ID list

WFS_ERR_CDM_NOCASHINSTARTED The WFS_CMD_CDM_CASH_IN_START was not issued before

Events The following additional events can be generated:

Value Meaning

WFS_EXEE_CDM_INPUTREFUSE A part of the amount of the cash in order was refused.

Comments None.