TransactionWebservice_1_1
Webservice for ICP-Mimas Transaction functions
The following operations are supported. For a formal definition, please review the Service Description.
-
Activate
Activate a card. As long as the card is not activated it has no value and cannot be used for payments. -
BalanceCheck
Lookup the balance of a card. -
Cancel
Cancel a previous performed successful transaction. The transaction may not have been cacelled before -
CashClaimCode
To cash the ClamCode that was requested with the GetClamCode. The card status may not be blocked. -
ClaimForgotCardBonus
Claim bonus points in case a customer has forgotten the card. The card status may not be blocked. -
Confirm
Confirm a previous performed successful activation. The reservation transaction must exist -
DeActivate
DeActivate a card. A card can be deactivated so that it cannot be used for payments. -
Discount
Provide the transaction amount and the discount precentage will be added to the balance. -
GetCardInfo
Get information of a card. For Third Party cards it depends if the gateway supports a CardInfo function. -
GetCardTypeCodes
Get card type code list. This function will provide the cardtype codes that are used for the ICP group. -
GetCardTypes
Get card type list. This function will provide the cardtypes that are used for the ICP group. -
GetClaimCode
To request a ClaimCode. The ClaimCode can be used in the CashClaimCode function to book the transaction value to the card. -
GetExchangeRate
Get Exchange Rate -
GetLimit
Get limit data. Get the limits list of a terminal or shop. -
GetProviderList
Get the provider list of a terminal. -
GetProviderLogo
Get the logo of a provier. The logo can for example be used in the menu selection list as they are usually colored images. -
GetTransaction
Get transaction. To get transaction details by reference or transactionId. -
Load
A card can be loaded with a value between the minimum and maximum load value. The value will be added to the current balance. -
Login
Login is the first function of the session to call. Only after a valid login other functions can be executed. -
LoginTerminal
LoginTerminal will login with a serialnumber validation. Only after a valid login other functions can be executed. -
Logout
Logout is the last function of the session to call. -
Payment
The balance on the card can be used for payments. The value will be subtracted from the balance. -
SystemCheck
The SystemCheck can be used to validate the connection to Mimas. This function will execute an query on the database. When it fails an error will be returned and otherwise succes. -
TransactionTicket
Get the ticket information of a previously performed transaction. The transaction must exist and have been completed. -
TransactionTotals
Get the transaction totals over a certain period of time. The totals are on TerminalCode level. Type is bitwise to make combinations: 1=details, 2=subtotals, 4=grandtotals -
TransactionWebserviceVersion
The version of the ICP-Mimas Transaction Webservice -
Transfer
Transfer a value from one card to another. The value will be subtracted from the source card and added to the destination card. -
VoucherCancel
Cancel a previously requested voucher. -
VoucherConfirm
Confirm a previously requested voucher. -
VoucherList
Get a list of vouchers that are allowed to request from a certain terminal ID. -
VoucherPayment
Redeem a voucher by providing the unique activation code. The voucher must be active or have status confirmed. -
VoucherPayout
The verification or payout function for lottery tickets. -
VoucherRequest
Request a voucher, topup, pin-printing or lottery ticket. -
VoucherReserve
Voucher request for web applications. This function is for vouchers that require personal information like name, address and email. -
VoucherSimRequest
Request a voucher with SIM activation. This function can be used for SIM activation using EID reader or SID scanner. -
VoucherStatus
Get the status of a voucher or confirm or cancel a previously requested voucher. A voucher request must always be confirmed or cancelled. -
VoucherTemplates
Get voucher templates of a product or provider. The ticket texts and logo will be returned. -
VoucherTicket
Get the voucher ticket of a previously requested voucher. The voucher must already have been confirmed or cancelled. -
VoucherTotals
Get the voucher totals over a certain period of time. The totals are on TerminalCode level. Type is bitwise to make combinations: 1=details, 2=subtotals, 4=grandtotals -
VoucherWebRequest
Voucher request for web applications. This function is for vouchers that require personal information like name, address and email. -
Vtc2MimasDestination
This function is to validate from a Vtc2Mimas application if a transaction must switch to VTC or to Mimas. The destination will be VTC or MIMAS