PurchasePointsService

Used for purchasing points.

The member provides a membership number, the point type he or she wants to purchase, and the number of points as input. Credit card details must also be given as the service might involve monetary payment. Once the service is complete, output is given as an XML file that shows the transaction number and the order number.

Member point balances are updated accordingly and reflected in the Siebel Loyalty application.

TransferPointsService

Used for transferring points to another member.

The member provides a membership number, the point type which he or she wants to purchase, and the number of points as input. The transferee member number must also be included as input. Credit card details must also be given as the service might involve monetary payment. Once the service is performed, output is given as an XML file that shows the transaction number and the order number.

Members' (transferor and transferee) point balances are updated accordingly and reflected in the Siebel Loyalty application.

LoungePurchaseService

Used to buy or renew Lounge.

The member provides a membership number, lounge period type, and lounge period duration along with credit card details. The member must also provide payment mode (Pay, Points, or Points+Pay) along with currency, and point type details as the service might involve payment.

After the service is performed, the Member's Lounge details are updated and a transaction detail record is created.

MembershipCancellationService

Used to cancel a loyalty membership.

The member provides a membership number and credit card information (using the same credit card used during membership enrollment, or renewal). The loyalty program fee is refunded to the member's credit card, and membership is cancelled.

RenewMembershipService

Renews the loyalty membership for members who are not enrolled in lifetime membership plans.

The member provides a membership number, and membership scheme along with payment details (payment mode, credit card details and point type details) as the input.

Membership dates are updated along with the membership scheme after the service is performed successfully.

GetMemberServicePrice

The member provides a membership number, and member service name to obtain price lists in different payment modes.

Output is an integration object that can be seen as an XML file.

MemberInquiry

Used to query for a member or members given the member names, member number, and so on.

The output details include member loyalty information, contact addresses, phone numbers, and email addresses, and so on.

PromotionEnrolmentForSMS

Rewards members a referral bonus when their social networking friends enroll into promotions.

Member Number

Required. The requesting member must provide the Siebel Loyalty membership number.

String

Point Type

Required. The purchasing member must specify the type of point that he or she wants to purchase.

String

Points

Required. The purchasing member must specify the number of points that he or she wants to purchase.

String

Billing Address

Member billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing Address2

Members secondary billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing City

Member billing city. Required if monetary or credit card details are a part of the transaction.

String

Billing Country

Member billing country. Required if monetary or credit card details are a part of the transaction.

String

Billing State

Member billing state. Required if monetary or credit card details are a part of the transaction.

String

Billing ZIP Code

Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.

String

CVV Number

CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.

String

Card Holder Name

Credit card holder's name. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Number

Credit card number. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Type

Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.

String

Currency

Currency type used by member. Required if monetary currency is part of the transaction.

String

Expiration Month

Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.

String

Expiration Year

Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.

String

Override Flag

Override flag.

String

Override Pay

Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.

String

Override Reason

The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.

String

Override Reason Code

A reason for the price list override is stated if this flag is set to Y.

String

Error Message

Error message given if the transaction fails.

String

Order Id

Order ID of the point purchase service.

String

Quote Id

Quote ID of the point purchase service.

String

Siebel Response Code

Siebel Order Management response code following authorization of a credit card.

String

Siebel Response Message

Siebel Order Management response message following authorization of a credit card.

String

Transaction Number

The transaction number of the point purchase service.

String

Member Number

Required. The requesting member must provide the Siebel Loyalty membership number.

String

Point Type

Required. The purchasing member must specify the type of point that he or she wants to purchase.

String

Points

Required. The purchasing member must specify the number of points that he or she wants to purchase.

String

Transferee Member Number

Required. Transferee membership number to whom the points are to be transferred.

String

Billing Address

Member billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing Address2

Members secondary billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing City

Member billing city. Required if monetary or credit card details are a part of the transaction.

String

Billing Country

Member billing country. Required if monetary or credit card details are a part of the transaction.

String

Billing State

Member billing state. Required if monetary or credit card details are a part of the transaction.

String

Billing ZIP Code

Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.

String

CVV Number

CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.

String

Card Holder Name

Credit card holder's name. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Number

Credit card number. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Type

Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.

String

Currency

Currency type used by member. Required if monetary currency is part of the transaction.

String

Expiration Month

Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.

String

Expiration Year

Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.

String

Override Flag

Override flag.

String

Override Pay

Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.

String

Override Reason

The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.

String

Override Reason Code

A reason for the price list override is stated if this flag is set to Y.

String

Error Message

Error message given if the transaction fails.

String

Order Id

Order ID of the point purchase service.

String

Quote Id

Quote ID of the point purchase service.

String

Siebel Response Code

Siebel Order Management response code following authorization of a credit card.

String

Siebel Response Message

Siebel Order Management response message following authorization of a credit card.

String

Transaction Number

The transaction number of the point purchase service.

String

Member Number

Required. The requesting member must provide the Siebel Loyalty Membership Number.

String

Lounge Period Type

Required. Lounge period type as months or years.

String

Lounge Period Duration

Lounge period duration for renewal stated in months or years.

String

Billing Address

Member billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing Address2

Members secondary billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing City

Member billing city. Required if monetary or credit card details are a part of the transaction.

String

Billing Country

Member billing country. Required if monetary or credit card details are a part of the transaction.

String

Billing State

Member billing state. Required if monetary or credit card details are a part of the transaction.

String

Billing ZIP Code

Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.

String

CVV Number

CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.

String

Card Holder Name

Credit card holder's name. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Number

Credit card number. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Type

Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.

String

Currency

Currency type used by member. Required if monetary currency is part of the transaction.

String

Expiration Month

Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.

String

Expiration Year

Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.

String

Override Flag

Override flag.

String

Override Pay

Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.

String

Override Points

The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.

String

Override Reason

A reason for the price list override is stated if this flag is set to Y.

String

Override Reason Code,

A reason for the price list override is stated if this flag is set to Y.

String

Payment Mode

Required. Payment mode stated as Points or Points+Pay, or Pay.

String

Point Type

Point type.

String

Error Message

Error message given if the transaction fails.

String

Order Id

Order ID of the point purchase service.

String

Quote Id

Quote ID of the point purchase service.

String

Siebel Response Code

Siebel Order Management response code following authorization of a credit card.

String

Siebel Response Message

Siebel Order Management response message following authorization of a credit card.

String

Transaction Number

The transaction number of the point purchase service.

String

Member Number

Required. The requesting member must provide the Siebel Loyalty Membership Number.

String

Membership Scheme

Required. The membership scheme to be renewed.

String

Billing Address

Member billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing Address2

Members' secondary billing address. Required if monetary or credit card details are a part of the transaction.

String

Billing City

Member billing city. Required if monetary or credit card details are a part of the transaction.

String

Billing Country

Member billing country. Required if monetary or credit card details are a part of the transaction.

String

Billing State

Member billing state. Required if monetary or credit card details are a part of the transaction.

String

Billing ZIP Code

Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.

String

CVV Number

CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.

String

Card Holder Name

Credit card holder's name. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Number

Credit card number. Required if monetary or credit card details are a part of the transaction.

String

Credit Card Type

Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.

String

Currency

Currency type used by member. Required if monetary currency is part of the transaction.

String

Expiration Month

Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.

String

Expiration Year

Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.

String

Override Flag

Override flag.

String

Override Pay

Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.

String

Override Points

The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.

String

Override Reason

A reason for the price list override is stated if this flag is set to Y.

String

Override Reason Code

A reason for the price list override is stated if this flag is set to Y.

String

Payment Mode

Required. Payment mode stated as Points or Points+Pay, or Pay.

String

Point Type

Point type.

String

Error Message

Error message given if the transaction fails.

String

Order Id

Order ID of the point purchase service.

String

Quote Id

Quote ID of the point purchase service.

String

Siebel Response Code

Siebel Order Management response code following authorization of a credit card.

String

Siebel Response Message

Siebel Order Management response message following authorization of a credit card.

String

Transaction Number

The transaction number of the point purchase service.

String

Member Number

Required. The requesting member must provide the Loyalty Membership Number.

String

Fee Refund Basis

Required. Fee refund basis. Values include Prorata or Percentage, or No Refund.

String

Refund Percentage

Refund percentage is to be given if the selected fee refund basis is calculated as a percentage.

String

Cancellation Reason

Reason for the membership cancellation.

String

Cancellation Reason Code

Required. Membership cancellation reason code.

String

Credit Card Number

Credit card number. Required when the refund basis is Percentage or Prorata. The fee is refunded to the credit card number provided that it matches the number previously retained.

String

Credit Card Type

Credit card type, such as Visa, MasterCard, and so on. Required when the refund basis is Percentage or Prorata. The fee is refunded to the credit card number provided that it matches the number previously on file.

String

Expiration Month

Expiration month must match the expiration month of the credit card on file. Required when the refund basis is Percentage or Prorata.

String

Expiration Year

Expiration year must match the expiration year of the credit card on file. Required when the refund basis is Percentage or Prorata.

String

Override Flag

Required. If the member wants to override the refund price details, then the input is Y, if not, then the input is N.

String

Override Pay

Required. If the member wants to override the price details then the input is Y, if not, then the input is N.

String

Override Reason

Reason for overriding price.

String

Override Reason Code

Override reason code provided if the Override Flag is Y.

String

Currency

Currency in which the fee is refunded.

String

Error Message

Error message if the transaction fails.

String

Order Id

Refund Order ID of the membership cancellation service.

String

Quote Id

Quote ID of the membership cancellation service.

String

Refund Amount

Refund amount.

String

Siebel Response Code

Response code provided by Siebel Order Management after the credit card authorization is sent.

String

Siebel Response Message

Response message given by Siebel Order Management after credit card authorization.

String

Transaction Number

The transaction number of the membership cancellation.

String

Member Number

The requesting member must provide the Siebel Loyalty Membership Number.

String

Currency Code

Currency code to return price lists in a given currency.

String

Lounge Period Duration

The Lounge period duration must be provided if the Transaction Sub Type is set to Lounge Purchase.

String

Lounge Period Type

Lounge Period type (Months or Years, and so on) must be provided if the Transaction Sub Type is set to Lounge Purchase.

String

Point Type

Point type must be provided if the member wants to see price lists of Points, or Points + Pay mode in the given point type.

String

Points Qty

Number of points to be given if the transaction sub type is set to Purchase Points or Transfer Points.

String

Selected Membership Scheme

Membership scheme included in the input if the Transaction Sub Type is Membership Renewal.

String

Transaction Sub Type

Required. Member Service type. Possible values are: Points Purchase, Transfer Points, Membership Renewal, or Lounge Purchase.

String

LOY EAI Transaction

List of price lines, after applying the promotions on the base prices, are given in the output as XML file.

Integration Object

Member Number

The requesting member must provide the Siebel Loyalty Membership Number.

String

Email Address

Email address of inquiring member.

String

First Name

Member's first name.

String

Last Name

Member's last name.

String

Middle Name

Member's middle name.

String

Telephone Number

Member's telephone number.

String

Transaction Type

Transaction type must be provided for queries.

String

ZIP Code

ZIP code of the member whose details are to be inquired is given.

String

Siebel Message (An instance of the integration object LOY Member Inquiry)

Member details are given in the integration object and can be extracted as XML file.

Integration Object

Member Number

Required. The member number of the enrollee.

String

Enrolled Promotion Id

Required. The enrolled promotion ID.

String

Incentive Choice

Optional. Incentive choice type.

String

Referred By Member Number

Optional. Member number of referee.

String

Error Message

Error message.

String

Siebel Message

Transactions in integration object format.

Integration Object