EVRWResultInformation Structure (POS for .NET v1.14.1 SDK Documentation)

Article
04/25/2017

4/4/2017

Defines a programmatic structure used to contain the tag name/value information returned by RetrieveResultInformation.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public Structure EVRWResultInformation

public struct EVRWResultInformation

public value class EVRWResultInformation

public final class EVRWResultInformation extends ValueType

Remarks

The following table defines the valid tag names as specified by the Unified Point of Service (UnifiedPOS) v1.14.1 international standard:

Tag name	Format	Description
AccessLogLastDateTime	Datetime	The time that the last transaction log was obtained.
AccountNumber	String	The account ID for the electronic value service.
Amount	Currency	The payment amount on the electronic money service
AmountForPoint	Currency	The amount targeted for calculating points. The amount is specified when the electronic value reader/writer device calculates the point values to be added at the same time as settlement, but there are some products not targeted for points.
AuthenticationStatus	Enumerated	Indicates the authentication status: ValueDescription EVRW_TAG_AS_AUTHENTICATEDAuthenticated EVRW_TAG_AS_UNAUTHENTICATEDUnauthenticated
AutoCharge	Boolean	If “True”, indicates a request to conduct an automatic charge at the time of issuing a method, or the result of an automatic charge at the time of completing the process.
Balance	Currency	The balance of the electronic value service.
BalanceOfPoint	Currency	The balance of the point service.
BusinessUnitID	String	The ID value for a store.
CardCompanyName	String	The name of the company issuing the electronic value media (card or mobile phone),
CardTransactionNumber	Number	The transaction number. This value is assigned and controlled by the electronic value service media (card or mobile phone).
ChargeableAmount	Currency	The amount for which charging is possible.
ChargeableCount	Number	How many times charging is possible.
ChargeMethod	Enumerated	Indicates the method to charge an electronic value service, either cash or exchanging points: ValueDescription EVRW_TAG_CM_CASHCharge as cash EVRW_TAG_CM_CREDITCharge as credit EVRW_TAG_CM_POINTCharge as points
DateTime	Datetime	The time that a method was issued, an event was notified, or a process was completed.
EffectiveDaysOfKey	Number	The number of days the Key value is effective.
EndAccountID	String	The ending point specified by an account ID when requesting closing or summary to the electronic value reader/writer.
EndDateTime	Datetime	The ending point specified by a date time when requesting closing or summary to the electronic value reader/writer.
EndEVRWTransactionNumber	Number	The ending point number specified by the reader/writer transaction sequential number when requesting closing or summary to the electronic value reader/writer.
EndPOSTransactionNumber	Number	The ending point number specified by a POS transaction number when requesting closing or summary to the electronic value reader/writer.
EVRWApprovalCode	String	The approval code for processing. This value is assigned and controlled by the electronic value reader/writer.
EVRWDateTime	Datetime	The date time managed by the electronic value reader/writer.
EVRWID	Number	The ID of the electronic value reader/writer.
EVRWTransactionLogID	String	The ID for transaction details stored in the electronic value reader/writer.
EVRWTransactionNumber	Number	The transaction number. This value is assigned and controlled by the electronic value reader/writer.
ExpirationDate	Datetime	The expiration date of the medium.
ExpiredAccountID	String	The description provided when information is held for an account already expired in the electronic value service media (card or mobile phone).
ForceOnlineCheck	Boolean	If “True”, indicates that there is a request to force the center to check online at the time of settlement.
InsufficientAmount	Currency	Indicates the insufficient amount when the balance is found insufficient by the electronic value reader/writer.
ItemCode	String	The item code for the product being handled in the settled transaction.
KeyExpirationDateTime	Datetime	The time when the Key expires.
KeyUpdateDateTime	Datetime	The time when the Key was last updated.
LastTimeBalance	Currency	The balance before settlement.
LastTimeCardTransactionLogID	String	The ID for the last time transaction details stored in the electronic value service media (card or mobile phone).
LastTimeEVRWTransactionLogID	String	The ID for the last time transaction details stored in the electronic value reader/writer.
LastUsedDateTime	Datetime	The most recent used date time of the medium.
LogCheck	Boolean	If “True”, indicates to check the transaction log when voiding the settlement.
MediaData	String	Information data for electronic value media (card or mobile phone) that is not related to POS. The content can be freely set by service providers or vendors.
MediumID	Number	The ID for electronic value service media (card or mobile phone).
MediumIssuerInformation	String	The information on the issuer of the medium.
MerchantID	String	The merchant identification information.
ModuleID	Number	The ID for individual settlement modules or applications that exist in the electronic value reader/writer that provides multiple services.
NegativeInformationType	Enumerated	The value indicating the type of negative transaction information. ValueDescription EVRW_TAG_NIT_ALLFull list of negative settlement information. EVRW_TAG_NIT_UPDATEDUpdated list of negative settlement information.
NegativeInformationUpdateTime	DateTime	The time when the negative information of the EVR/W was updated.
NumberofAddition	Number	The number of charge settlement transactions.
NumberofEVRWTransactionLog	Number	The number of transaction details stored in the electronic value reader/writer.
NumberOfFreeEVRWTransactionLog	Number	The number value of free space for transaction details stored in the electronic value reader/writer.
NumberOfRecord	Number	The number of records.
NumberofSentEVRWTransactionLog	Number	The number of transaction details that are stored in the electronic value reader/writer and have been sent to the settlement center.
NumberOfSubtraction	Number	The number of settlement transactions.
NumberOfTransaction	Number	The total number of transactions.
NumberOfUncompletedAddition	Number	The number of transactions uncompleted due to communication errors between the electronic value reader/writer and electronic value media (card or mobile phone) during the charge settlement transaction.
NumberOfUncompletedSubtraction	Number	The number of transactions uncompleted due to communication errors between the electronic value reader/writer and electronic value media (card or mobile phone) during the settlement transaction.
NumberOfUncompletedVoid	Number	The number of transactions uncompleted due to communication errors between the electronic value reader/writer and the electronic value media (card or mobile phone) while voiding transactions.
NumberOfVoid	Number	The number of voided transactions.
OtherAmount	Currency	The amount for extra payment when used for the transaction together with a regular settlement.
PaymentCondition	Enumerated	Indicates the type of payment for the settlement amount in case of post-pay type electronic value services: ValueDescription EVRW_TAG_PC_INSTALLMENT_2Installment 2 EVRW_TAG_PC_INSTALLMENT_3Installment 3 EVRW_TAG_PC_BONUS_1Bonus 1 EVRW_TAG_PC_BONUS_2Bonus 2 EVRW_TAG_PC_BONUS_3Bonus 3 EVRW_TAG_PC_BONUS_4Bonus 4 EVRW_TAG_PC_BONUS_5Bonus 5 EVRW_TAG_PC_BONUS_COMBINATION_1With extra payment by bonus 1 EVRW_TAG_PC_BONUS_COMBINATION_2With extra payment by bonus 2 EVRW_TAG_PC_BONUS_COMBINATION_3With extra payment by bonus 3 EVRW_TAG_PC_BONUS_COMBINATION_4With extra payment by bonus 4 EVRW_TAG_PC_INSTALLMENT_1Installment 1 EVRW_TAG_PC_LUMPLump-sum EVRW_TAG_PC_REVOLVINGRevolving
PaymentDetail	String	The type of payment for the settlement amount in case of post-pay type electronic value services.
PaymentMethod	Enumerated	Indicates the type of settlement of the transaction amount required by the electronic value reader/writer: ValueDescription EVRW_TAG_PM_COMBINEDSettlement combined with other payment EVRW_TAG_PM_FULL_SETTLEMENTFull settlement
PaymentMethodForPoint	Enumerated	Indicates the settlement method to be used for calculating points: ValueDescription EVRW_TAG_PMFP_CASHCash EVRW_TAG_PMFP_CREDITCredit EVRW_TAG_PMFP_EMElectronic money EVRW_TAG_PMFP_OTHEROther
Point	Number	The point value requested to the electronic value reader/writer from POS.
POSDateTime	Datetime	The time of accounting managed by POS.
POSTransactionNumber	Number	Sequential number that identifies the POS transaction.
RegistrableServiceCapacity	Number	The quantity of services that can be registered.
RequestedAutoChargeAmount	Currency	The amount requested for automatic charge.
ResponseCode1	Number	The primary result code for processing. This value can be freely set by service providers or vendors.
ResponseCode2	Number	The primary result code for detailed processing. This value can be freely set by service providers or vendors.
ResultOnSettlement	Enumerated	Indicates the result status of the settlement transaction between the electronic value reader/writer and the electronic value media (card or mobile phone): ValueDescription EVRW_TAG_ROS_NGAbnormal termination EVRW_TAG_ROS_OKNormal termination EVRW_TAG_ROS_UNKNOWNUnidentified
RetryTimeout	Number	The amount of time, in milliseconds, when it is necessary to retry processing between the electronic value reader/writer and the electronic value media (card or mobile phone) after the electronic value media was last connected with the electronic value reader/writer.
SettledAmount	Currency	The amount actually settled with the electronic value reader/writer.
SettledAutoChargeAmount	Currency	The automatic charge value actually settled by the electronic value reader/writer.
SettledMemberInformation	String	The member information in the membership certificate after it has been updated.
SettledOther-Amount	Currency	The actual amount of extra payment when an electronic value service is used with other settlement methods.
SettledPoint	Number	The point value actually settled by the electronic value reader/writer.
SettlementNumber	Number	The sequential number for the clearing process.
SignatureFlag	Boolean	Indicates if it is necessary to sign after the settlement or not.
SoundAssistFlag	Boolean	If “True”, indicates to activate voice navigation.
StartAccountID	String	The starting point specified by an account ID when requesting closing or summary to the electronic value reader/writer.
StartDateTime	Datetime	The starting time when requesting closing or summary to the electronic value reader/writer.
StartEVRWTransactionNumber	Number	The starting point number specified by the reader/writer transaction sequential number when requesting closing or summary to the electronic value reader/writer.
StartPOSTransactionNumber	Number	The starting point number specified by a POS transaction number when requesting closing or summing to the electronic value reader/writer.
SummaryTermType	Enumerated	Indicates the term for the summary process. ValueDescription EVRW_TAG_STT_1From the previous type of summary result to current EVRW_TAG_STT_2From the summary result before the previous type of result to the previous summary result EVRW_TAG_STT_3From the summary result two times before the previous type of summary result to the summary result before the previous result
TaxOthers	Currency	Tax and other currency amounts included in the required settlement amount.
TotalAmountOfAddition	Currency	The total amount of charge settlement transactions.
TotalAmountOfSubtraction	Currency	The total amount of settlement transactions.
TotalAmountOfTransaction	Currency	The total currency amount of transactions.
TotalAmountOfUncompletedAddition	Currency	The total currency amount of transactions uncompleted due to communication errors between the electronic value reader/writer and electronic value media (card or mobile phone) during the charge settlement transaction.
TotalAmountOfUncompletedSubtraction	Currency	The total currency amount of transactions uncompleted due to communication errors between the electronic value reader/writer and electronic value media (card or mobile phone) during the voiding transaction.
TotalAmountOfVoid	Currency	The total currency amount of voiding transactions.
TouchTimeout	Number	The timeout in milliseconds until the electronic value reader/writer is touched by electronic value media (card or mobile phone).
TransactionType	Enumerated	Indicates the type of transaction for the electronic value service: ValueDescription EVRW_TAG_TT_ADDAdding (charge) EVRW_TAG_TT_CANCEL_CHARGECanceling charge EVRW_TAG_TT_CANCEL_RETURNCanceling/Return EVRW_TAG_TT_CANCEL_SALESCanceling sales EVRW_TAG_TT_GET_LOG Acquiring a transaction log EVRW_TAG_TT_READReading (reference) EVRW_TAG_TT_RETURNReturn EVRW_TAG_TT_SUBTRACTSubtracting (sales) EVRW_TAG_TT_WRITEWriiiting
UILCDControl	Boolean	If “True”, indicates that the LCD is controlled when the electronic value reader/writer has an LCD.
UILEDControl	Boolean	If “True”, indicates that the LED is controlled when the electronic value reader/writer has an LED.
UISOUNDControl	Boolean	If “True”, indicates that sound is controlled when the electronic value reader/writer plays sounds.
VOIDorRETURN	Enumerated	Indicates how a transaction is voided: ValueDescription 1Void 2Return
VoidTransactionType	Enumerated	Indicates the type of transaction to be voided: ValueDescription 1Cash 2Exchanging points
VoucherID	String	The ID of the voucher or ticket.
VoucherIDList	String	A list of enumerated IDs of the voucher/ticket.
WorkstationID	String	The POS ID.
WorkstationMaker	String	The manufacturer’s code of the workstation manufacturer.
WorkstationSerialNumber	String	The manufacturer’s serial number or the identification code of the POS workstation.

The following table defines the tag formats as specified by the UnifiedPOS v1.14.1 international standard:

Format	Description
String	A text character string.
Number	A 32 bit integer value represented by text characters.
Currency	A 64 bit Integer value represented by text characters. The last four digits represent the value after the decimal point. Example: a tag value of “1234567” translates to a currency value of 123.4567.
Datetime	A date time represented by text characters in the following format: yyyy-mm-ddThh:mn:ss.sssTZD - (dash) is the character separator between date elements. yyyy is a 4-digit number representing the year. mm is a 2-digit number representing the month, where 01 = January and 12 = December. dd is a 2-digit number representing the day of the month, from 01 to 31. T is the character separator between the date and the time. : (colon) is the character separator between the time elements. hh is a 2 digit number representing the hour, from 00 to 23. mn is a 2-digit number representing the minutes, from 00 to 59. ss is a 2-digit number representing the integer part of the seconds, from 00 to 59. . (period) is the character separator between the time and the fractional seconds. sss is a 1-digit to 3-digit number representing the fractional seconds. TZD represents an optional time zone designator, which is Z, +hh:mm, or -hh:mm. Z indicates that the time zone is GMT. +hh:mm or –hh:mm indicates a delta from GMT, where hh indicates the hours (from 00 to 14) and mm indicates the minutes (from 00 to 59). Example: 2008-04-12T23:20:50.275-05:00 represent April 12, 2008, 23 hours, 20 minutes, and 50.275 seconds in New York (GMT – 5 hours).
Boolean	A logical type indicated by the text characters “True” or “False”.
Enumerated	A text string that indicates one of a set of possible values for a particular tag name.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

Share via

EVRWResultInformation Structure (POS for .NET v1.14.1 SDK Documentation)

Syntax

Remarks

Thread Safety

See Also

Reference

Additional resources