This data type is used to transfer an authentication request to the system. It contains a Principal which is automatically mapped to system internal alias identifiers and a Credential. In special cases, the Credential may be left empty when authentication was already done via another way, e.g. manually (trusted by partner). In case of conversational WebService usage, the Credential may be replaced by a valid conversation identifier. Principal of the member who wants to access a WebService method. Credential of the member who wants to access a WebService method. Valid conversation id for a WebService based workflow. When a conversation id is provided, no credential is necessary. The backend system checks the validity of conversation id. This data type is used to transfer information about a principal. It consists of a principal identifier and a classifier that categorizes the principal type. The value to use as Principal (e.g. card number 4235 2345 5499 12). The 'type' of the given Principal value (e.g. 1, which means that the given value must be interpreted as a card number and not as a EAN or phone number) String-based value of the Principal that is passed for authentication. Classification of the given Principal value. It allows the backend to understand whether the PrincipalIdentifier has to be parsed as a card number, a EAN, a phone number, an email address etc. Currently we allow either 16-digit PAYBACK card number OR 10 digit mobile number (if mobile is linked with PAYBACK card) PIN OR date of birth (6 digit - YYMMDD OR 4 digit - DDMM) if member has no PIN, needed to authenticate the given Principal. Unique identifier of a WebService conversation used in order to support workflows. Timeout-based for temporary use. Unit of measurement of loyalty currency. Standard response base type with fault message object Fault data sent for the StitchAssociation service call LMS_00001=Invalid request, Request XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found LMS_00005=Member is disabled; please ask member to contact PAYBACK customer care LMS_00006=Invalid request, PartnerShortName or BusinessUnitShortName is invalid LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. LMS_00013=Invalid request, PrincipalClassifier is invalid Type used to transfer detailed information about an account balance. It comprises not only absolute points in loyalty currency but also information about available points and expired points. The loyalty currency of all amounts in this account balance record. The total amount of points in this account. The amount of available points in this account. The amount of blocked points in this account.(Total blocked earns) An optional announcement to warn the member that some of his points will expire soon. An optional statistics information to inform the member how many point already expired. Amount of points in a certain loyalty currency. Announcement that a certain amount of points will expire soon. The amount of points that will expire soon. The expected date of expiration. Statistics of point that already in expired in the past. The number of points that already expired since a certain point in the past. The begin of the expiration interval that was taken into account. Type to describe expiry dates (targeted precision and format is YYYY-MM-DD). Fault data sent for the createVoucherRedemption service call LMS_00001=Invalid request, Request XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found LMS_00004=Member not registered, please request member to register LMS_00005=Member is disabled; please ask member to contact PAYBACK customer care LMS_00006=Invalid request, PartnerShortName or BusinessUnitShortName is invalid LMS_00007=Burning of points is not allowed for the partner. Please contact PAYBACK support LMS_00008=Invalid request, ChannelClassifier is invalid LMS_00009=Insufficient points LMS_00010=Invalid request, RedemptionDateTime has wrong format LMS_00011=Points requested to burn is too less. Try higher value. LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. LMS_00013=Invalid request, PrincipalClassifier is invalid LMS_00014=Invalid request, LoyaltyCurrency is invalid LMS_00015=Unknown terminal, please contact PAYBACK support. LMS_00016=Member account expired LMS_00017=Member authentication failed, Credential is invalid. Standard response base type with fault message object. Fault data sent for the GetAccountBalance service call LMS_00001=Invalid request, XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. LMS_00013=Invalid request, PrincipalClassifier is invalid LMS_00014=Invalid request, LoyaltyCurrency is invalid LMS_00016=Member account expired Standard response base type with fault message object. Fault data sent for the IsMobileLinked service call LMS_00001=Invalid request, XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. Standard response base type with fault message object. Fault data sent for the IsMobileLinked service call LMS_00001=Invalid request, XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. Standard response base type with fault message object Fault data sent for the EnforcePinStatus service call LMS_00001=Invalid request, XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found, Either loyalty card no is not valid OR mobile not linked OR member/Card state is not valid LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. LMS_00013=Invalid request, PrincipalClassifier is invalid LMS_00018=Both Email and linked mobile not available to send PIN details, please contact Call center to update profile information. LMS_00019=PIN generation failed, please contact call center. Member is dummy OR DOB not updated(DOB is default) Standard response base type with fault message object Fault data sent for the VerifyMembership service call LMS_00001=Invalid request, Request XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found LMS_00005=Member is disabled; please ask member to contact PAYBACK customer care LMS_00006=Invalid request, PartnerShortName or BusinessUnitShortName is invalid LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. LMS_00013=Invalid request, PrincipalClassifier is invalid Basic type used as an 'exception' that is thrown by a WebMethodin case of errors when it was not possible to achieve thedesired result resp. to create the desired return value.In the majority of cases it can be assumed, that the underlying business transaction was rolled back when a Fault is thrown and therefore no change was made in the database. Error code used in the fault message to precisely identify the type of interal exception/error that occurred during processing of the WebService request. In most cases, this is an error code generated by a business logic component and can be interpreted in its context. Error message used in the fault message to give a humans a readable and interpretable indication concerning what went wrong during processing of the WebService request. In contrast to the error code, this message string might be translated and therefore available in the customization's preferred language. Classification of the communication channel used for a certain activity (e.g. POS, Kiosk, Web, ...) This type allows to transfer a description of the partner organization and the partner system that participated in a transaction. Hierarchy to follow is: Partner --> BusinessUnit --> Branch --> Terminal Short name that identifies the partner organization. Short name that identifies the partner organization. Short name that identifies the partner organization. Short name that identifies the partner organization. EnforcePinStatus returns success status response code and message to the caller in the below scenarios, If Pin is already set If new pin is generated and sent to both email and linked mobile If new pin is generated and sent to email only IF new pin is generated and sent to linked mobile only Code to map the message Standard response base type with fault message object Fault data sent for the GetMemberCardsByEmailID service call LMS_00001=Invalid request, Request XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found LMS_00006=Invalid request, PartnerShortName or BusinessUnitShortName is invalid LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. Standard response base type with fault message object Fault data sent for the GetMemberCardsByEmailID service call LMS_00001=Invalid request, Request XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found LMS_00006=Invalid request, PartnerShortName or BusinessUnitShortName is invalid LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. Standard response base type with fault message object Fault data sent for the GetMemberCardsByEmailID service call LMS_00001=Invalid request, Request XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found LMS_00006=Invalid request, PartnerShortName or BusinessUnitShortName is invalid LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. Payback Member's Loyalty Card Number. The amount of available points in this account. Latest transaction date with any partner and the partner lmid of this latest transaction is returned in this element. Latest transaction date with the partner lmid sent in the request is returned in this element. Enrollment Source of the member's Payback card. Promocode of the member's Payback Card. Searched by Mobile OR Email The mobile number of the PAYBACK member. Customer Email ID to retrive payback cards Payback Member's Loyalty Card Number. The amount of available points in this account. Latest transaction date with any partner and the partner lmid of this latest transaction is returned in this element. Latest transaction date with the partner lmid sent in the request is returned in this element. Enrollment Source of the member's Payback card. Promocode of the member's Payback Card. Transaction date of the most recent transaction of this member. Partner LMID of the most recent transaction of this member. An effective date is a date, when the reason of an event or transaction being created (e.g. a purchase), happened. A human readalbe, string-based identifier to name organizations in external interfaces. Our standard date-time-stamps format (incl. time zone information). Describes instances identified by the combination of a date and a time. Its value space is described as a combination of date and time of day in Chapter 5.4 of ISO 8601. Its lexical space is the extended format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] Object identifier that is valid 'outside' our system, i.e. it can be used by external systems to reference system-internal objects like customers or organizations under their external name. Member activity id OR transaction reference number 10 digit Mobile number. This type is used by isMobileLinked and verifyMembership api's. This type is used by isMobileLinked and verifyMembership api's. Member's full name. Member's Email id Member's 16 digit payback card number. This type describes the medium used by the customer to interact with PAYBACK. Basic type for lic-based, customizable enumerations. All enumerations that are customizeable (e.g. salutations, channels etc.) are represented by non-negative integer based language independent codes internally. This type is meant to be *abstract*. It must not be used directly but only to derive other lic-based types. This data type is used to transfer an authentication request to the system. It contains a Principal (and an optional PrincipalVariant) which is automatically mapped to system internal alias identifiers and a Credential. In special cases, the Credential may be left empty when authentication was already done via another way, e.g. manually (trusted by partner). Alias identify a member within the PAYBACK program. Alias type defines the classification and derived from this the usage of an alias. Alias identify a member within the PAYBACK program. Alias type defines the classification and derived from this the usage of an alias. Alias identify a member within the PAYBACK program. Alias type defines the classification and derived from this the usage of an alias. Alias identify a member within the PAYBACK program. Alias type defines the classification and derived from this the usage of an alias. Principal secret type that is used (optionally used if applicable - don't use it if not necessary). Credential of the member who wants to access a WebService method in case of a fire and forget call. String-based enumeration that defines the flavor of the Principal (e.g. Card Number, Phone Number, ...). Type for 'OTP'. Used for Association Number/Association Account Number String-based enumeration that defines the flavor of the Principal (e.g. Card Number, Phone Number, ...). Type for secret type LOV. Type for GetAccountTransactionsByPartner - PartialInfoRequest LOV. Data used to identify the partner. Partner LMID should be sent in the request. Orders specific to this partner is returned by this service call. Channel Classification where redemption is done(e.g. POS, PG, OTC, EDC etc.) Optional element in the request. Data used to identify partner terminal. If terminal id is sent in the request, Orders specific to this partner terminal is returned. Data used to identify the member. Either 16-digit loyalty card number OR 10-digit linked mobile number can be sent. If member identification is sent in the request, orders only specific to this member is returned. From and To Dates are mandatory. Orders placed between this period will be fetched. This element can be Order Id OR Activity Id Order Id for (PG, OTC, CC, WEB, KIOSK channels) Activity Id for POS redemptions channel used by member to redeem points - CC, WEB, PG, OTC, KIOSK, POS etc. Number of result records that will be skipped Number of result records to be returned. Type to identify a single day in the calendar. It can be used as a boundary value to specify calendar periods. Type for pagination Number of result records that will be skipped Number of result records to be returned Pre-sorting conditions. The full result set will be sorted using this sorting condition. Using this sort result the paging will be executed. Type used to transfer detailled event information about a single event assigned to dedicated account. Unique short name of the partner, the partner's business unit and the partner's branch where the event was created Effective date. Date of event creation at partner (including time zone information) Key number of a the event Must be unique for a certain partner. Alias that triggered the event creation Returns the apropriate eventtype for the current event. AccountTransactionDetail record assigned to the event Product Name Cash component of the order This type allows to transfer a description of the partner organization and the partner system that participated in the PAYBACK program. Hierarchy to follow is: Partner --> BusinessUnit --> Branch Short name that identifies the partner organization. Partner display name that identifies the partner organization. Short name that identifies the partner's business unit. Business unit display name that identifies the partner's business unit. Short name that identifies the partner's branch. Branch display name that identifies the partner's branch. Type used to transfer detailled information about a single transaction which is booked into an account A short descriptive text explaining the transaction. Actual value may be a simple transaction classifier (like e.g. 'Purchase' or 'Retrocredit') or a marketing text that is derived from the marketing code that was created by the partner. The transactions value, i.e. the number of point in loyalty currency that were added to or removed from the account. Amount of loyalty currency together with its unit of measurement. Type to transfer a descriptive text for a transaction. A human readable, descriptive identifier that names organizations in user interfaces. Denotes the superset of all event types of either categories (collect event and redemption events). Type for pagination page size definition Type for pagination sort options Type for pagination sort criteria (LOV tbd.) Type for pagination sort direction (LOV 0=asc/1=desc) Standard response base type with fault message object. Fault data sent for the OrderStatusEnquiry service call LMS_00001=Invalid request, XML validation failed. LMS_00002=Unknown failure, please contact PAYBACK support. LMS_00003=Member Not found. Invalid Loyalty card number OR Mobile number. LMS_00006=Invalid request, PartnerShortName or BusinessUnitShortName is invalid. LMS_00008=Invalid request, Redemption Channel is invalid. LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. LMS_00013=Invalid request, PrincipalClassifier is invalid LMS_00015=Unknown terminal, please contact PAYBACK support. Error codes Error codes Error codes Type for search result size Type used to transfer detailed order information. This can be Order Id for PG/OTC orders OR activity id for POS redemptions. Date of event creation at partner. Invoice number or Receipt number. Key number of a receipt issued at a partner. Must be unique for a certain partner. Number of points in loyalty currency redeemed from this account. Number of points in loyalty currency refunded from this account. if order refund was done multiple times, OrderRefundInfo is repeated. Details of the activity or transaction of a member. Type used to transfer detailed event information about a single event assigned to dedicated account. Transaction Id or event Id 16-digit loyalty card number of a member Transaction date(Date of event creation) Activity Date format('DD-MM-YYYY') Identifies transaction type - EARN/BURN/EARN REVERSAL etc. External Terminal Id Partner Id Partner Commercial Name Defines Transaction mode. Voucher Burn, Points Expiry, Goodwill Points, BONUS POINTS, Refund etc. enrollment source Transaction Value or amount Number of points in loyalty currency that were added to or removed from the account. Loyalty Terminal ID Referenced Activity Id Activity action code. EARN, BURN, EARN REVERSAL etc. transaction type code. POINTS_EXPIRY, GDWILL_PTS, BONUS_POINTS, POINTS_BACK, REFUND etc. activity reject reason Flex5 Flex7 unique_identification Date of creation of event blocked until date of blocked earns(date format - 'DD-MM-YYYY') Alias identify a member within the PAYBACK program. Alias type defines the classification and derived from this the usage of an alias. Authentication Number identify a member within the PAYBACK program. Association Type states the type of association LOY_CARD_NUMBER/MOBILE_ID/ICICI_CREDIT/ICICI_DEBIT etc. String-based value of the Principal that is passed for authentication. String-based enumeration that defines the flavor of the Principal (e.g. Card Number, Phone Number, ...). This key identifies if the Partner is a valid partner and enabled for real time earns. This key identifies the type of transaction for real time earns. Type to define the Partner UId (Invoice no.) sent by the Partner for real time earn API's. Member activity id OR transaction reference number Type to define the Partner UId (Invoice no.) sent by the Partner for real time earn API's. Type to describe transaction dates (targeted precision and format is YYYY-MM-DD). All the associated Base earn transaction Ids. Invoice number of the base earn transaction sent by the partner. If Partner is calculating points, Payback Activity Id of the base earn transaction sent by the partner. Basket data consists of basket or item Information specific to the transaction. Each Line item consists of key and value pair. Key for the given line item. Value for the given key for the particular line item. Additional information sent by partner to be captured as Key Value pair. Each Line item consists of key and value pair. Key for e.g. VAT Amount, PaymentType, TxnUnit Value for the given key for the particular line item. It consists of Rejected Id and reject reason. Reject Id for the transaction. Reject reason for the transaction. 1. "0" cannot cancel. Once blocked make it complete , 2. null - can cancel 3. integer number - he can cancel till these many mins, after taking order. Standard response base type with fault message object. Fault data sent for the Real Time Earn service call Map all the Fault codes and Fault messages Standard response base type with fault message object. Fault data sent for the Real Time Earn service call Map all the Fault codes and Fault messages Standard response base type with fault message object. Fault data sent for the Real Time Earn service call Map all the Fault codes and Fault messages Standard response base type with fault message object. Fault data sent for the Real Time Earn service call Map all the Fault codes and Fault messages This is the base type for all web service requests. Its only element is a data type that is used for partner authentication and subsequent authorisation. Concrete web service requests are supposed to extend this type by appending their own elements. Data used to identify and authenticate the consumer that has submitted the request and provide additional details on the consumer. Type to indentiy a consumer in more detailed information on the concrete device. ConsumerAuthentication uniquely identifys and authorises the consumer. Only proper consumer authentication authorizes the consumer to access the PAYBACK system. Each consumer requires an interface contract with PAYBACK to reveive valid consumer authentication. PAYBACK Partner that is responsible for the interface contract with PAYBACK and that operates the consumer. Identifier for the individual device within the consumer network. Examples are terminalIds IP address or the IMEI Product relevant for the PAYBACK product stack (e.g. Online Toolbar, iPhoneApp, BackberryApp, full-size terminal, small-size terminal) Version of the service used by the consumer This data type is used to transfer an authentication request of a interface consumer to the PAYBACK system A valid principal of the consumer who wants to access a WebService method. This principal is unique for the consumer and will be used to identify the consumer uniquely within the PAYBACK system Credential of the consumer who wants to access a WebService method. ID of the technical device. For terminals this is known as terminalID for other devices this could be the IP address or the IMEI Product from the PAYBACK product stack (Online Toolbar, iPhoneApp, BlackberryApp, full-size terminal, small-size terminal) Type for api version used by consumer. Type to transfer the string-based value of the Principal that is used for identification or authentication (e.g. a username, cardnumber etc.). Standard response base type with fault message object. This type allows to transfer a description of the partner organization and the partner system that participated in the PAYBACK program. Hierarchy to follow is: Partner --> BusinessUnit --> Branch Short name that identifies the partner organization. Short name that identifies the partner's business unit. Short name that identifies the partner's branch. Type for security CAPTCHA answer. Unique identifier for the CAPTCHA generated by a separate service call. This ID is only valid for a single request. The text that the user retrieved from the security CAPTCHA and provides to PAYBACK system. Type used for business process specific authorisation tokens. The plain text that was contained within the CAPTCHA Complex data type used to transfer the 'core' information about a member, i.e. the minimum information needed to handle him as a human beeing in case he contacts the call center: his name, gender etc. Further member related information is captured in other types The salutation used to greet the PAYBACK member. The first name of the PAYBACK member. The last name of the PAYBACK member. The date of birth of the PAYBACK member. Type for the salutations of the PAYBACK members (LICs only). Type for the first name of a PAYBACK member. Type for the last name of a PAYBACK member. Type for the date of birth of a PAYBACK member. Complex data type used to transfer the postal address information of a PAYBACK member. The data type is defined to support different ways of addressing (normal postal address or post box as well as more open classification schemes as they are used in less-developed countries e.g. free text to name cross-roads or nearby shops or monuments). The semantics of additional and extra fields is fully depending on the customizing context. The zip code of the PAYBACK member's address. The coty of the PAYBACK member's address. The region or state of the PAYBACK member's address. Usage of region/state names is depending on the country. Some additional information further describing the PAYBACK member's address. Semantics is customizing-specific. Some more additional information further describing the PAYBACK member's address. Semantics is customizing-specific. Some extra information further describing the PAYBACK member's address. Semantics is customizing-specific. Type for 'zip code' part of an address of a PAYBACK member. Type for 'city' part of an address of a PAYBACK member. Type for 'region' part of an address of a PAYBACK member. Type for the additional info part of an address of a PAYBACK member. Interpretation is expected to be customizing-specific. Type for the extension info part of an address of a PAYBACK member. Interpretation is expected to be customizing-specific. Complex data type used to transfer additional contact information about a PAYBACK member. It can contain landline and mobile phone number and email address information. The mobile phone number of the PAYBACK member. LinkMobile take boolean values YES - API should link/associate mobile number to the loycarnumber if the mobile number is not linked/associated NO - API should not link/associate mobile number to the loycarnumber The email address of the PAYBACK member. Complex data type used to transfer additional contact information about a PAYBACK member. It can contain landline and mobile phone number and email address information. The mobile phone number of the PAYBACK member. The email address of the PAYBACK member. This type combines an unprocessed phone number with its characteristics in order to allow proper processing. The actual raw phone number in unprocessed format. Type for unprocessed phone numbers. Unprocessed means that the phone numbers are 'as written down by a member', e.g. 00 49 (0) 89 112344-55 (i.e. containing braces, +, -, . and space characters). Further on, the international break-out codes (like 00 or 810) might be included or not. It is up to the backend to perform phone number validation, cleansing and reformatting. This type combines an unprocessed email address with its characteristics in order to allow proper processing. The actual email address in unprocessed format. Type for raw unprocessed email adresses. It is up to the backend to perform email address validation, cleansing and reformatting if necessary. This data type is used to transfer an authentication request to the system for conversational WebService usage. It requires a valid conversation identifier. Token in the form of a hexadecimal string issued to grant access to data of a specific member. A token has an expiry period which might be infinit and a state (weak or strong) that determines whether usage of the token in subsequent services is provided or not. Type that defines the keys/types used as additionaldata collected from member. All content only valid with respect to a customizing. Value of additional member data Assigned alias represent as subset of Alias withint the PAYBACK program. The value for an alias of type Assigned Alias must be provided externally PB will not generate the value for alias of such type Alias identify a member within the PAYBACK program. Alias type defines the classification and derived from this the usage of an alias. Type used to transfer detailled information about an account balance. It comprises not only absolute points in loyalty currency but also information about available points and expired points. The loyalty currency of all amounts in this account balance record. The total amount of points in this account. The amount of available points in this account. The amount of blocked points in this account. The amount of total collected points in this account. The amount of total spend points in this account. An optional announcement to warn the member that some of his points will expire soon. An optional statistics information to inform the member how many point already expired. Type for profile information for the current member in case only anonymous member data is allowed to be used at the client side. optional preferred language can be set by the member optional setting of country specific value format (e.g. number, date) Country of residence of the member The area that the member's addess belongs to. Type for the genders of the PAYBACK members (LICs only). Type for language codes according to the ISO 639-1:2002 standard. Only two letter lower case ASCII character strings are allowed. Type for country codes according to the ISO 3166-1 ALPHA-2 standard. Only two letter upper case ASCII character strings are allowed. Type for surrounding area. Part of the address data information that can be used to determine the surrounding area of the member (e.g. ZIP Code, city, region) The concrete information derived from the address data of the member that can be used to determine the sur-rounding area Type forsurrounding area identifier. 1 - ZIP 2 - CITY 3 - DISTRICT 4 - PROVINCE 5 - REGION Type for surrounding area value. The general marketing and research agreement with the PAYBACK member. The email newsletter marketing agreement with the PAYBACK member. The SMS marketing agreement with the PAYBACK member. Type that holds the consent to subscriptions Type that holds information about the order date of a subscription for a PAYBACK member. Denotes the versions of a subscription in order to differentiate between legal terms and conditions with respect to the PAYBACK program that the members has agreed on. This might influence program behaviour towards the member. Type that holds the consent to subscriptions for marketing, research, email service, sms service and customizing specific generic services. Type that holds information about the additional subscriptions of a PAYBACK member. All content only valid with respect to a customizing. Type that defines the keys/types used as additional subscription. All content only valid with respect to a customizing. Value of the addtional subscription List of member card details for request mobile number Single member card details for request mobile number This element represents the loyalty card number Member's Enrollment source. Member's Pomo Code(Enrolled Partner promocode) Member's Logo Code(Membership TYPE). Mobile number is used to identify MI(MOBILE_ID) association or associated profile numbers When GetAccountBalanced method completed successfully, a list containing 1 AccountBalanceDetail records is returned. There's exactly 1 record for each loyalty currency that was found when no currency was selected. In the case that a currency was selected, a single record is returned. Member's Enrollment source. Member's Pomo Code(Enrolled Partner promocode) Member's Logo Code(Membership TYPE). Response message for GetMemberCardDetailsByMobile API MemberDetails Type has following three member details 1. Loyalty card number 2. Mobile Number 3. EmailId 16 Digit Loyalty card Number Mobile number is used to identify MI(MOBILE_ID) association or associated profile numbers Customer Email ID to retrive payback cards Standard response base type with fault message object. Fault data sent for the Confirm burn points service call Map all the Fault codes and Fault messages Classification of the Redemption channel used for a certain activity (e.g. POS, Kiosk,...) Type used to transfer detailed information about an account balance. It comprises not only absolute points in loyalty currency but also information about available points and expired points. The loyalty currency of all amounts in this account balance record. LMID (loyalty Merchant Id) Prepaid account balance with the no. of points available after the transaction for the given Partner. Prepaid account balance with the no. of points available after the transaction for the given Partner. Threshold Amount. Prepaid account balance with the no. of points available after the transaction for the given Partner. The expected date of expiration. Type used to transfer detailed information about an account balance. It comprises not only absolute points in loyalty currency but also information about available points and expired points. The loyalty currency of all amounts in this account balance record. LMID (loyalty Merchant Id) The total amount of points in this account. Order id or transaction reference number The amount of blocked points in this transaction Campaign Id provided by the partner Prepaid account balance with the no. of points available after the transaction for the given Partner. The expected date of expiration. Identifies the member and his account based on the given alias and then returns the actual balance of the account. As an account can be setup to cover more than one loyalty currency, the caller of this method should indicate in which loyalty currency he is interested. If no selection is made, the method will return a list comprising all balances for all currencies applicable to the account in question. Data used to identify and authenticate the member requesting the redemption. Optional field to select the loyalty currency in multi-currency systems. If not specified, all balances in all currencies will be returned. Optional field which specifies whether to send OR not to send loyalty card number in the response. If not specified, or if this field value is 'NO', loyalty card no element will not be returned in the response. If this field value is 'YES', Loyalty Card Number is returned in the response. Decides if the point is prepaid YES -Point is prepaid No- Point is not prepaid LMID (loyalty Merchant Id) When GetAccountBalanced method completed successfully, a list containing 1 to n AccountBalanceDetail records is returned. There's exactly 1 record for each loyalty currency that was found when no currency was selected. In the case that a currency was selected, a single record is returned. AccountBalanceDetail record filled by the backend according to the loyalty currency selected. Summary of account balance with the no. of points available before and after the transaction. Member 16 digit Payback Card Number. Optional field, returned only if specified in the request element 'SendLoyCardNo'. Data used to identify and authenticate the member requesting the redemption. Data used to identify the partner organization of this redemption as precise as possible (including the business unit, branch and maybe the terminal). Optional field to select the loyalty currency in multi-currency systems. It can be left out when the inquiry goes to a single-currency system. The amount of points of this redemption. The point in time when this redemption happened. The receipt id identifying the transaction made in the POS. An optional field to transfer the voucher number. If no voucher number is given, it may be assumed that the ReceiptCode can be interpreted as a voucher number. Field that identifies the channel that was used to submit this redemption request. GetMobileAndEmail take boolean values YES - API should return loyalty card, mobile and email in case of error NO - API should not return any member details When GetAccountBalanced method completed successfully, a list containing 1 to n AccountBalanceDetail records is returned. There's exactly 1 record for each loyalty currency that was found when no currency was selected. In the case that a currency was selected, a single record is returned. AccountBalanceDetail record filled by the backend according to the loyalty currency selected. Member activity id or transaction reference number MemberDetails type is having following three member details Loyalty card number Mobile Number Email Id Identifies if the mobile number is linked to PAYBACK card. if PAYBACK member wants to use his mobile number at POS instead of LOYALTY card number, this service verifies if the account is linked to mobile number Returns 'YES' or 'NO' Below Additional information sent in the response. Member's full name, email id, and card number will be sent as optional infromation. 10 digit mobile number IsMobileLinkedResponse returns status as 'YES' or 'NO' based on mobile is linked with any PAYBACK member or not. If mobile is linked then other infromation like full name, email and card number will be returned in the response as optional fields. Mobile linked status(Yes/No) Member's full name Member's Email id Member's Loy Card Number This service checks the PIN status of a PAYBACK member. If member is having PIN = DDMM(same as DOB), this service generates new PIN and triggers Email, and sms to linked mobile with PIN details. PAYBACK member is identified based on 16-digit loyalty card no OR 10-digit linked mobile number. This service validates member and card state. For valid cards, checks if PIN already exists for this member. If Pin exists, sends response as 'PIN Already Set' If Pin is NULL or PIN == DDMM(same as DOB) and if either registered email OR linked mobile exists, New PIN is generated and sent to: 1. EMail and sms, if both email and linked mobile exists 2. EMail, only if registered email is available 3. SMS, only if linked mobile exists ERROR response is sent to contact Call center for the below scenarios: 1. If both linked mobile and email doesnot exists 2. If member is dummy 3. If member is having default DOB('11/11/1911') If member OR card validation fails, appropriate ERROR code and message is sent in the response If valid PIN exists or new PIN is generated and PIN is sent to email or sms, appropriate success code and message is sent in the response Data used to identify and authenticate the member. Success Response codes: LMS_SCS_0001=Pin Already Set LMS_SCS_0002=New PIN sent to Email and Linked mobile LMS_SCS_0003=New PIN sent to Email LMS_SCS_0004=New PIN sent to Linked mobile Fault Response codes: Fault data sent for the EnforcePinStatus service call LMS_00001=Invalid request, XML validation failed LMS_00002=Unknown failure, please contact PAYBACK support LMS_00003=Member not found, Either loyalty card no is not valid OR mobile not linked OR member/Card state is not valid LMS_00012=Wrong communication protocol used. The protocol should be either HTTP or HTTPS. Please check with PAYBACK if both HTTP and HTTPS are allowed. LMS_00013=Invalid request, PrincipalClassifier is invalid LMS_00018=Both Email and linked mobile not available to send PIN details, please contact Call center to update profile information. LMS_00019=PIN generation failed, please contact call center. Member is dummy OR DOB not updated(DOB is default) This API is for Checking whether member belongs to particular PromoCodes mapped to the partner. Partner will send member Card# or MI and additionally pass LMID in the request. LMS will maintain LMID mapping to Promocodes For Example: Phantaloon LMID is 65555 and Promocodes - PTL, PTT, PTF, PTS, PTO If No Mapping is done, api will return ‘No’ in the response If member promocode matches with LMID-Promocode map, api will return ‘Yes’ in the VerifyMembership api response Data used to identify and authenticate the member requesting for membership verification Short name that identifies the partner organization - Partner LMID verify membership status(Yes/No) This api is called by partner who want to retrieve customer PAYBACK information by 'email-id' of the customer. Partner will send lmid(loyalty merchant id) and email-id of the customer in the request. In response, this api returns below PAYBACK information of the customer 1. 'PAYBACK card number' - 16 digit loyalty card no 2. 'Total available points' for redemption in member's Payback account 3. 'latest transaction date' and 'partner lmid' of the latest transaction 4. 'latest transaction date with partner' and 'lmid of partner' sent in the request 5. 'enrollment source' of the member's payback card 6. 'promocode' of the member's payback card Members are searched by email-id (exact search and case insensitive) All the active Payback cards found are returned in the response. There is no specific sorting of the cards retreived. If LMID passed in the request is the PARENT PARTNER lmid, 'LAST TRANSACTION DATE WITH PARTNER' will be - member's latest transaction date with the parent partner OR with any of the child partners, whichever is the latest. If LMID passed in the request is the CHILD PARTNER lmid, 'LAST TRANSACTION DATE WITH PARTNER' will be - member's latest transaction date with the child partner Customer Email ID to retrive payback cards Short name that identifies the partner organization - Partner LMID Filter out the member based on following filters Takes following values YES - filter should be applied in following sequence 1 - Members with Linked mobile 2 - Members with recently used(Earn, Burn and profile update) 3 - Member with highest points 4 - Member with recent registration(signedup date) No- No filter should be applied To fetch user details based on the LMID. Data used to identify and authenticate the member Short name that identifies the partner organization - Partner LMID Partner authorization key to check, if the partner is provisioned. StorID TillID The mobile number of the Store Manager. The mobile number of the Store Manager. Short name that identifies the partner organization - Partner LMID This element represents the loyalty card number The first name of the PAYBACK member. The last name of the PAYBACK member. This element represents Central PremiumTier. This element represents Central PremiumTier dateTime. This element represents LTM Spends. This element represents New Status. This element represents Review Month. This element represents Spends Till dateTime. This element represents Balance Spends Current Tier Retention. This element represents Balance Spends In Nine Month. This element represents Balance Spends In Eleven Month. This element represents Balance Tier Upgrade In One Month. This element represents Balance Tier Upgrade In Three Month. This element represents Campaign Format. This element represents Campaign Start dateTime. This element represents Campaign End dateTime. This element represents Campaign Spends. This element represents Spends Frequency Achieved. This element represents Spends Achieved. Frequency Achieved at current format Under 1x1 during campaign.. This element represents Spends At Current Format. This element represents Spend Frequency. This element represents Cross Format. INTF:ForgotPassword - Execute generation of new password (assigned alias) and send this to member using via preferred channel and contact data of the member. Data used to identify and authenticate the member The communication channel describes the medium used by the member to interact with PAYBACK The SendMobileAndEmail is an optional element in the request to decide whether to send masked mobile and emial id in the response. It takes two values "YES" - returns masked mobile and email "NO" - mobile and email ids will not be returned The date of birth of the PAYBACK member. For errors see separate error code document. INTF:OrderStatusEnquiryRequest Retrieve order details by passing - 'order id' and 'redemption channel' in the request. Retrieve list of orders of a specific 'partner' and 'redemption channel' for a period by passing - (partner lmid, redemption channel, date range - From and To dates) in the request Retrieve list of orders of a 'member with specific partner and redemption channel' by passing – (partner lmid, loyalty card no OR linked mobile, redemption channel, date range - From and To dates) in the request There is also an option to filter for specific partner terminal. Order list is sorted by Order Date - descending order Retrieve order details by passing order id and redemption channel in the request Retrieve List of Orders Reports can be fetched for the below filters - [LMID, Redemption Channel, FROM Date, TO Date] Mandatory 1. LMID, Redeem channel, From Date and To Date 2. LMID, LTID, Redeem channel, From Date and To Date 3. LMID, Redeem Channel, Authentication(loy card no OR mobile no), From Date and To Date 4. LMID, LTID, Redeem Channel, Authentication(loy card no OR mobile no), From Date and To Date order details are returned in the response. Order list is sorted by Order Date in descending order. Order Details filled by the backend. returns number of available records found for this service call. INTF# ReverseVoucherRedemption: allows both 'partial' and 'complete' refund of points allows refund for specific channels – PG, OTC, POS etc.(configurable at Payback) Order Refund is not allowed for 'WEB' and 'CC' (ofbiz orders) allows Refund for both 'Pending' and 'Completed' Orders Refund is allowed only within REFUND period (REFUND days configurable at Payback) FALSE, if refund is allowed again. TRUE, if refund is final and no further refunds allowed. 16 digit Payback Card Number INTF# GetAccountTransactionsByPartner : API based (Real time retrieval) of Point summary and transactions of a member with specific partner. Partner can send either payback card number OR linked mobile no of the customer, and LMID of the partner. By default, last 10 transactions are returned. For transaction history, Partner has to send 'start date' and 'end date' payback card number OR linked mobile no of the customer. Transactions of a member with this payback card number is returned. Decides if the point is prepaid YES -Point is prepaid No- Point is not prepaid Transactions from this date is returned Transactions till this date is returned LMID of the partner. Complex Type having LMID(mandatory), hasChild(optional) HasChild - when set to 1, - Return member transactions with all child partners of the partner as well Haschild - when set to 0, - Return only transactions of a member with the partner LMID sent in the request Type which decides if, only partial transaction details Or Complete transaction details has to be returned Scope of the GetAccountTransactionsByPartner API: Real time retrieval of Point summary and transactions of a member with specific partner, using PAYBACK card number or mobile number of the customer. Partner has to send customer's PAYBACK Card number Or linked Mobile no. and LMID By default, last 10 transactions are returned. Start Date and End Dates are optional. For transaction history, partner has to send 'start date' and 'end date'. Fetch 1000 transactions that falls within the 'start date' and 'end date'(max limit configurable at PAYBACK) Below Customer point details is returned by Payback. - Total Point Balance - Total Available points for redemption - Total points blocked (blocked earn points) - Points going to expire next month Summary of account balance with the no. of points available before and after the transaction. 16 digit payback card number Returns number of available records found for this service call. INTF# GetAccountTransactionsByPartner : API based (Real time retrieval) of Point summary and transactions of a member with specific partner. Partner can send either payback card number OR linked mobile no of the customer, and LMID of the partner. By default, last 10 transactions are returned. For transaction history, Partner has to send 'start date' and 'end date' payback card number OR linked mobile no of the customer. Transactions of a member with this payback card number is returned. Partner authorization key to check, if the partner is provisioned and to verify, if the partner is enabled for the real time earns or not. Loyalty Merchant ID(LMID) of the merchant where the transaction took place. Must be a valid LMID provided by Payback. Loyalty Terminal ID(LTID) of the partner outlet where the transaction took place. Must be a valid LTID provided by Payback. Invoice number of this earn transaction sent by the partner. Unique identifictaion number which cannot be duplicated for a specific partner. Partner authorization key to check, if the partner is provisioned and to verify, if the partner is enabled for the real time earns or not. Transactions from this date is returned Transactions till this date is returned LMID of the partner. Complex Type having LMID(mandatory), hasChild(optional) HasChild - when set to 1, - Return member transactions with all child partners of the partner as well Haschild - when set to 0, - Return only transactions of a member with the partner LMID sent in the request Type which decides if, only partial transaction details Or Complete transaction details has to be returned Scope of the GetAccountTransactionsByPartner API: Real time retrieval of Point summary and transactions of a member with specific partner, using PAYBACK card number or mobile number of the customer. Partner has to send customer's PAYBACK Card number Or linked Mobile no. and LMID By default, last 10 transactions are returned. Start Date and End Dates are optional. For transaction history, partner has to send 'start date' and 'end date'. Fetch 1000 transactions that falls within the 'start date' and 'end date'(max limit configurable at PAYBACK) Below Customer point details is returned by Payback. - Total Point Balance - Total Available points for redemption - Total points blocked (blocked earn points) - Points going to expire next month 16 digit payback card number Returns number of available records found for this service call. INTF#010: Returns list of bookings within the account ordered by effective date (date of occurrence of the event that triggered the booking) in descending or-der, optionally restricted by time-interval or number of records (start with latest).If a loyalty currency was included within the request, only the transactions details for the single currency will be returned. Otherwise, PAYBACK system returns transaction for all currencies. Data used to identify and authenticate the member requesting his account's transactions. Defines the number of transaction records (regardless of the number of events where the transactions are assigned to) which shound be returned. Parameters required if paging of resultset shoud be executed within the PAYBACK system (server-side paging) Flag to Send extended details For errors see separate error code document. Event Data of events assigned to the accout via the chain Account -> Membership -> Alias -> Event. returns number of available records found for this service call. Only returned if paging is used Request to process points to the customer account near real time and customer should be able to view the same real time across all PB channels. Data used to identify and authenticate the member. Partner authorization key to check, if the partner is provisioned and to verify, if the partner is enabled for the real time earns or not. Loyalty Merchant ID(LMID) of the merchant where the transaction took place. Must be a valid LMID provided by Payback. Loyalty Terminal ID(LTID) of the partner outlet where the transaction took place. Must be a valid LTID provided by Payback. Invoice number of this earn transaction sent by the partner. Unique identifictaion number which cannot be duplicated for a specific partner. Additional UID used by some Partners. Should be captured in Unique_identification If Payback is calculating points, Partner has to send transaction amount for Earns If Partner is calculating points, Partner has to send preallocated points with this earn transaction that has to be credited to member's account. A code of length 15 identifying the type of transaction, which is displayed in the transaction list and also used for analytics puposes; the value will be provided by PAYBACK to the partner at the time of sign-up/partner on-boarding. Typical values: * CASH_CASH * BONUS_POINTS * GDWILL_PTS * RETRO * RECONCILIATION Channel Classification from where request has been sent e.g. POS, Kiosk, Web, etc. Communication Channel of the request. Txn Date & Time for this earn transaction Partner settlement date for this earn transaction. Must be between the Txn Date and current date (both inclusive) Flex1 - Additional Info sent by the Partner used for the display purpose. Activity_batch_number - Transaction Batch No to be sent by the Partner. Flex8 - Transaction branch Id of Partner. Flex7 - Actual transaction value sent by the Partner. This is the actual transaction value and points will not be earned on this amount. Campaign Id sent by the Partner. Decides if the point is prepaid YES -Point is prepaid No- Point is not prepaid Optional field to define the reference id of the base transaction. This transaction is considered as a base transaction if this is empty or null Key for the given line item. Key can be categorized into two: Fixed - Fields that we are already capturing, for e.g. VAT Amount, PaymentType, TxnUnit Variable Fields - For all other fields. This will be stored under a new table as key value pair Basket data sent along with each earn request. For errors see separate error code document. If Earn Transaction is successful, Payback UID (activity id) is returned to the partner If Earn Transaction is successful, Partner UID (Invoice No) is returned to the partner If Earn Transaction is successful, Loyalty Card Number is returned to the partner If Earn Transaction is successful, the no of points earned with this request is returned Summary of account balance with the no. of points available before and after the transaction. Summary of account balance with the no. of points available before and after the transaction. Rejected Code (RejectID) and reject reason is returned Request to process reversal of points from the customer account near real time and customer should be able to view the same real time across all PB channels. Data used to identify and authenticate the member. Partner authorization key to check, if the partner is provisioned and to verify, if the partner is enabled for the real time earn reversals or not. Loyalty Merchant ID(LMID) of the merchant where the transaction took place. Must be a valid LMID provided by Payback. Loyalty Terminal ID(LTID) of the partner outlet where the transaction took place. Must be a valid LTID provided by Payback. Unique transaction UId of the original earn activity. Old Partner UId of the original Earn transaction. Old Payback UId of the original Earn transaction. Partner to send the new invoice number for this transaction. This is mandatory field if the earn reversal request is for partial earn reversal. Txn Date & Time for this earn reversal transaction If Payback is calculating points, Partner has to send transaction amount for Earns If Partner is calculating points, Partner has to send preallocated points with this earn transaction that has to be credited to member's account. Channel Classification from where request has been sent e.g. POS, Kiosk, Web, ... Communication Channel of the request. NO, by default, if subsequent reversals allowed for the base transaction. YSE, if this reversal request is final and no further reversal allowed for the base transaction. For errors see separate error code document. If transaction is successful, Payback UID (activity id) is returned to the partner If transaction is successful, Partner UID (Invoice No) is returned to the partner If transaction is successful, Loyalty Card Number is is returned to the partner If Earn Reversal Transaction is successful, points reversed for this transaction If Earn Reversal Transaction is successful, total available points in the account before and after this transaction Rejected Code (RejectID) and reject reason This request is to cater the modification of points or amount or modification or cancellation of blocking period of the base earn transaction. Customer should be able to view the same real time across all PB channels. Data used to identify and authenticate the member. Partner authorization key to check, if the partner is provisioned and to verify, if the partner is enabled for the real time earn modifications or not. Loyalty Merchant Id(LMID) of the merchant where the transaction took place. Must be a valid LMID provided by Payback. Loyalty Terminal Id(LTID) of the partner outlet where the transaction took place. Must be a valid LTID provided by Payback. Unique transaction UId of the original earn activity. Partner has a choice to send either Partner UId or Payback UId that was sent in the response of original earn transaction Old Partner UId of the original Earn transaction. Old Payback UId of the original Earn transaction. Partner to send the new invoice number for this transaction. Txn Date & Time of this modification request for the original earn transaction If Payback is calculating points, Partner has to send transaction amount for Earns If Partner is calculating points, Partner has to send preallocated points with this earn transaction that has to be credited to member's account. Channel Classification from where request has been sent e.g. POS, Kiosk, Web, ... Communication Channel of the request. New blocking period to be updated against the original earn activity. For errors see separate error code document. If transaction is successful, Payback UID (activity id) is returned to the partner If transaction is successful, partner UID (Invoice No) is returned to the partner if partner sends new partner UId in request same will be captured and return in this element If transaction is successful, Loyalty Card Number is returned to the partner If transaction is successful and request was sent for points modification then points modified for this transaction is returned If transaction is successful, total available points in the account before and after this transaction New blocking period till which the points will be blocked. Rejected Code (RejectID) and reject reason Data used to identify and authenticate the member. LMID (loyalty Merchant Id) LTID (loyalty Terminal Id) Branch short name(branch Id) Unique invoice number sent by the Partner The receipt code identifying the transaction made in the POS. If Payback is calculating points, Partner has to send transaction amount for Earns These many points to be blocked for that member This is the blocking period, means its threshold time for unblocking 1. "0" --> Order cannot be canceled. 2. The null(no tag in the request) - Order cannot be canceled. 3. Signed integer nnumber- Order can be canceled till these many minutes after creation Channel Classification from where request has been sent e.g. POS, Kiosk, Web, etc. Communication Channel of the request. Used by PG to send SMS for the successful order completion. GetMobileAndEmail take boolean values YES - API should return loyalty card, mobile and email in case of error NO - API should not return any member details Decides if the point is prepaid YES -Point is prepaid No- Point is not prepaid One Time PIN sent to linked mobile number to process redemption 16 Digit Loyalty card Number AccountBalanceDetail record filled by the back-end according to the loyalty currency selected. Order id or transaction reference number The amount of blocked points in this transaction Summary of account balance with the no. of points available before and after the transaction. MemberDetails type is having following three member details Loyalty card number Mobile Number Email Id INT#050: This command is used to log in a member. It takes the alias and a secret and checks if it is a valid combination of aliastype and secrettype and re-turns a token granting the member access to his/hers PAYBACK account and data. This token must later be used to identify that user in subsequent com-mands requiring prior authentication. If no secret is passed, then the authentication also returns a token but with a different set of permissions. The permission assigned to the token determines the authorization for subsequent service-calls for that token. The authorization is checked by the PAYBACK system for each service call. Moreover, the token expires in the server after a (possibly infinit) period. It also checked by the PAYBACK system. After entering invalid secrets several times for the same alias (the no of times is determined by the PAYBACK system) then the user can be forced to incorporate a CAPTCHA within the subsequent authentication retry (only in case such functionality is configured for the current PAYBACK system). When the CAPTCHA has not been solved correctly, no login will be attempted, avoiding e.g. the possibil-ity of an automated script locking many accounts. Therefore the Authenticate command returns an error that indicates to call the service createCaptcha() which returns a CaptchaID and a CaptchaURL that references CAPTCHA. The text (answer) from this CAPTACH must be provided in the subsequent Authentica-tion-call for the same alias together with the original CaptchaID to secure the answer. The CaptchaID is valid for only a single Authentication attempt Data used to identify and authenticate the member requesting his account's balance(s). Data used to identify and authenticate the member requesting his account's balance(s). GetMobileAndEmail take boolean values YES - API should return loyalty card, mobile and email in case of error NO - API should not return any member details For errors see separate error code document. Token in the form of a hexadecimal string issued to grant access to data of a specific member. A token has an expiry period which might be infinit and a state (weak or strong) that determines whether usage of the token in subsequent services is provided or not. MemberDetails type is having following three member details Loyalty card number Mobile Number Email Id INTF#008. This command allows to create a new membership (to do an enrollment). If no card number is given as parameter, a new PAYBACK account will be created for the membership. If a cardnumber is passed then this cardnumber will be assigned to the newly created member. The memberdata will be stored an the member will grant access to the account determined by the cardnumber (E-Kit). All alias that are assigned to the member will be returned. Additionally, the command returns a token granting access to the PAYBACK account. This token must later be used to identifity the user in other commands requiring prior authentication. Depending on the correctness of the address data provided , completion of the creation process may require two consequitive calls: In the first call the addressvalidation flags should be set to "on". As a result the address data and contact data will be validated. If this check fails, the "Adress-Correctness" values in the response will be set to provide the reason why. Additionally the address data and contact data output parameters may contain up-dated values, if applicable for the particular code value. Note that in case of an invalid address or contact data provided and adressvalidation set to "on", execution of the service will not create a new member nor any data will be persisted within the PAYBACK system. This state of service execution is indicated by a error message returned in the FaultMessage element of the service response. In the second call the addressvalidation flag should be set to "off" to allow the users overwrite so that no check is done this time and the enrolment will be executed. The third addressvalidation-option "On/Save" validates address data and contact data provided but always enroles the member regardless of the validation result. This validation result will be store with the address and contact data. For security reasons it should be avoided to execute an enrollment without CAPTCHA, hence parameters secret and answer are required in case the current PAYBACK system is configured for usage of CAPTCHA. Optional result of a security CAPTCHA usage in conjuction with this request. PAYBACK cardnumber provided. The cardnumber must always be a "generated alias" . Provision of this parameter executes "enrollment with card" process. A member is allowed to assign at least one secret (e.g. password) The most important data to identify a member, including his name, date of birth etc. Data used to identify and authenticate the member requesting his account's balance(s). For errors see separate error code document. Token in the form of a hexadecimal string issued to grant access to data of a specific member. A token has an expiry period which might be infinit and a state (weak or strong) that determines whether usage of the token in subsequent services is provided or not. Generated alias (cardnumber) that is as-signed to the member as "first generated alias". This alias is bound to the member-ship enrolled and cannot be assigned to a further membership List of further generated alias (cardnumbers) that are initially assigned to the membership after enrolment. These alias can subsequently be used to enrole further members to the account Returns the Validata status of the validated addresses (Postal, Email, Mobile) The member's postal address is returned if the address has been adjusted by the PAYBACK system during enrollment. The member's contact addresses are returned if at lease on of the contact addresses has been adjusted by the PAYBACK system during enrollment. PAYBACK cardnumber provided. The cardnumber must always be a "generated alias" . Provision of this parameter executes "enrollment with card" process. INTF#15: Provide member data that should be updated. For all updated member data except additional data the PAYBACK system will keep track of data history. In case address or contact data will be provided note the following: Depending on the correctness of the address data provided, completion of theupdate process may require two consequitive calls: In the first call the addressvalidation flags should be set to "on". As a result the address data and contact data will be validated. If this check fails, the "Adress-Correctness" values in the response will be set to provide the reason why. Additionally the address data and contact data output parameters may contain up-dated values, if applicable for the particular code value. Note that in case of an invalid address or contact data provided and adressvalidation set to "on", execution of the service will not update the memberdata nor any data will be persisted within the PAYBACK system. This state of service execution is indicated by an error warning message returned in the FaultMessage element of the service response. In the second call the addressvalidation flag should be set to "off" to allow the users overwrite so that no check is done this time and the update will be executed. The third addressvalidation-option "On/Save" validates address data and contact data provided but always update the member data regardless of the validation result. This validation result will be store with the address and contact data. Data used to identify and authenticate the member requesting his/her data updation. Data used to identify and authenticate the member requesting his account's balance(s). IFor errors see separate error code document. Returns the Validata status of the validated addresses (Postal, Email, Mobile) The member's postal address is returned if the address has been adjusted by the PAYBACK system during enrollment. The member's contact addresses are returned if at lease on of the contact addresses has been adjusted by the PAYBACK system during enrollment. INTF#029: returns the complete customer information Data used to identify and authenticate the member Data used to identify and authenticate the member requesting his account's balance(s). For errors see separate error code document. Returns the Validata status of the validated addresses (Postal, Email, Mobile) Contains the set of assigned alias which is a subset of all alias for the member. INTF#059: This service provides a reduced set of member data to populate the initial dashboard presented to the member right after authentication of this member or startup of a client application. Depending on the token permissions the consumer, only a subset of information may be returned Data used to identify and authenticate the member. Data used to identify and authenticate the member requesting his account's balance(s). For errors see separate error code document. All information on the balances of the account for each loyalty currency Contains profile information of the current member. Can be used on case only anonymous memher data is required on consumer side. The list of alias of the assigned to the member Standard PAYBACK program subscriptions set by member If true member has recently received a new password/PIN must be forced by client to update his password within the current client session. Members master data Digital contact channels of the member. List of the additional subscriptions of a PAYBACK member. All content only valid with respect to a customizing. This API is to retrieve Member card details by Mobile number(MI or Profile Mobile) Mobile number is used to identify MI(MOBILE_ID) association or associated profile numbers This element is an enumaration of YES/NO - Used to check whether to return account balance in response. Default is NO i.e if element is not present in request Associated member card details of requerst mobile number List of member card details for request mobile number Data used to identify the order. Unique invoice number sent by the Partner LMID (loyalty Merchant Id) Channel Classification from where request has been sent e.g. POS, Kiosk, etc. Redemption Channel of the request. This flag take YES/NO value. If YES, system should send SMS for confirmation of order. If NO, system should not send SMS for confirmation completion. Order number which is being confirmed Unique invoice number which is being confirmed. Order status after processing (Confirmed) This api is called by partner who want to retrieve customer PAYBACK information by 'email-id' of the customer. Partner will send lmid(loyalty merchant id) and email-id of the customer in the request. In response, this api returns below PAYBACK information of the customer 1. 'PAYBACK card number' - 16 digit loyalty card no 2. 'Total available points' for redemption in member's Payback account 3. 'latest transaction date' and 'partner lmid' of the latest transaction 4. 'latest transaction date with partner' and 'lmid of partner' sent in the request 5. 'enrollment source' of the member's payback card 6. 'promocode' of the member's payback card Members are searched by email-id (exact search and case insensitive) All the active Payback cards found are returned in the response. There is no specific sorting of the cards retreived. If LMID passed in the request is the PARENT PARTNER lmid, 'LAST TRANSACTION DATE WITH PARTNER' will be - member's latest transaction date with the parent partner OR with any of the child partners, whichever is the latest. If LMID passed in the request is the CHILD PARTNER lmid, 'LAST TRANSACTION DATE WITH PARTNER' will be - member's latest transaction date with the child partner The mobile number of the PAYBACK member. Customer Email ID to retrive payback cards Short name that identifies the partner organization - Partner LMID The date of birth of the PAYBACK member. INT#050: This command is used to log in a member. It takes the alias and a secret and checks if it is a valid combination of aliastype and secrettype and re-turns a token granting the member access to his/hers PAYBACK account and data. This token must later be used to identify that user in subsequent com-mands requiring prior authentication. If no secret is passed, then the authentication also returns a token but with a different set of permissions. The permission assigned to the token determines the authorization for subsequent service-calls for that token. The authorization is checked by the PAYBACK system for each service call. Moreover, the token expires in the server after a (possibly infinit) period. It also checked by the PAYBACK system. After entering invalid secrets several times for the same alias (the no of times is determined by the PAYBACK system) then the user can be forced to incorporate a CAPTCHA within the subsequent authentication retry (only in case such functionality is configured for the current PAYBACK system). When the CAPTCHA has not been solved correctly, no login will be attempted, avoiding e.g. the possibil-ity of an automated script locking many accounts. Therefore the Authenticate command returns an error that indicates to call the service createCaptcha() which returns a CaptchaID and a CaptchaURL that references CAPTCHA. The text (answer) from this CAPTACH must be provided in the subsequent Authentica-tion-call for the same alias together with the original CaptchaID to secure the answer. The CaptchaID is valid for only a single Authentication attempt Data used to identify and authenticate the member requesting his account's balance(s). Short name that identifies the partner organization - Partner LMID One Time PIN sent for mobile linking through WEB/PORTAL Association Number identify a member within the PAYBACK program. Association Account Number identify a member within the PAYBACK program. Association Type states the type of association LOY_CARD_NUMBER/MOBILE_ID/ICICI_CREDIT/ICICI_DEBIT etc. Valid From Date & Time for association Valid To Date & Time for association Data used to identify and authenticate the member requesting his account's balance(s). For errors see separate error code document. Data used to identify and authenticate the member. The date of birth of the PAYBACK member. Data used to identify and authenticate the member requesting his account's balance(s). IFor errors see separate error code document. Returns the Validata status of the validated addresses (Postal, Email, Mobile) The member's postal address is returned if the address has been adjusted by the PAYBACK system during enrollment. The member's contact addresses are returned if at lease on of the contact addresses has been adjusted by the PAYBACK system during enrollment. Generates OTP to send to the linked mobile number. 10 digit mobile number LMID (loyalty Merchant Id) Data used to identify and authenticate the member requesting his account's balance(s). Send the response back whether OTP is generated and sent to linked mobile number or failed due to some validation