Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 Back to Rewards Main Page

Status
colourGreen
titleAvailable from CRM.COM R10.0.0

Excerpt
hiddentrue

Learn how the rules set at established in the Rewards Participating Merchant Merchants are applied and how they affect System behaviour -

Status
colourGreen
titleAvailable from CRM.COM R10.0.0

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Using Rewards

Using Rewards Participating Merchant

rules

Rules

Each of the The rules defined on the in the Rewards Participating Merchant is  are triggered when whenever the specific process is executed in the system. Read on to find out how the . The application by the System of the various configurations of the rule is described below. 

Applying Rewards Participating Merchants Award Rules

This set of processes is used in order to apply the award rules specified on a rewards participating merchant. The following logic is applied:

On evaluating a customer event in order to award it

  • If the customer event was performed by a unit that is not represented by an effective or not effective rewards participating merchant then
    • The standard (existing) functionality is applied in order to award the customer event
  • If the customer event was performed by a unit that is represented by a not effective rewards participating merchant then
    • No award is provided
  • If the customer event was performed by a unit that is represented by an effective rewards participating merchant then
  • If the "Award rewards participants owned by merchant's group" is disabled and the rewards participant related with the customer event is owned by the merchant's group then
    • No award is provided
  • If the "Award rewards participants owned by other collaborating groups" option is disabled and the rewards participant related with the customer event is owned by another collaborating group then
    • No award is provided
  • If the merchant

    When a Customer Event associated with a Reward Offer is created, the following checks and actions take place upon its evaluation:

    CASERESULT
    Customer Event is performed by a Unit that is not represented by a Rewards Participating Merchant.Award is provided.
    Customer Event is performed by a Unit that is represented by a Rewards Participating Merchant whose state is 'Not Effective'.Award is not provided.
    Customer Event is performed by a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    Award Rewards Participants Owned by Merchant's Group is 'Disabled'
    AND
    Rewards Participant is related with the Customer Event is owned by the Merchant's Group
    Award is not provided.
    Customer Event is performed by a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    Award Rewards Participants Owned by Other Collaborating Groups is 'Disabled'
    AND
    Rewards Participant is related to the Customer Event is owned by another collaborating Group.
    Award is not provided.
    Customer Event is performed by a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    The Merchant is allowed to award offers belonging to specific
    schemes then
    Schemes.Awards are provided only by offers belonging to the
    schemes
    Schemes that both the
    merchants

    Merchant is allowed to award and the
    schemes
    Schemes that the
    rewards participant is participating toIf the merchant
    Rewards Participant is participating in.
    Customer Event is performed by a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    The Merchant is allowed to award offers belonging to any
    schemes then
    Schemes.

    Awards are provided only by offers belonging to the

    schemes

    Schemes that

    that

    the

    rewards participant

    Rewards Participant is participating

    to

    in.

     

    Applying Rewards Participating Merchants Spend Rules

    This set of processes is used in order to apply the spend rules specified on a rewards participating merchant. The following logic is applied:

    • On submitting a spend request customer event 
      • If the spend request was performed by a unit that is not represented by an effective or not effective rewards participating merchant then
        • The standard (existing) functionality is applied in order to award the customer event
      • If the spend request was performed by a unit that is represented by a not effective rewards participating merchant then
        • The spend request is not allowed
      • If the spend request was performed by a unit that is represented by an effective rewards participating merchant then
        • If the "Submit spend requests on behalf of rewards participants owned by merchant's group" is disabled and the rewards participant related with the spend request is owned by the merchant's group then
          • The spend request is not allowed
        • If the "Submit spend requests on behalf of rewards participants owned by other collaborating groups" option is disabled and the rewards participant related with the customer event is owned by another collaborating group then
          • The spend request is not allowed
        • Else
          • The standard (existing) functionality is applied in order to award the customer event
    Icon

    Note that spend requests can also be done through the purchase customer events create_spend Web API method. This process should be applicable through that Web API as well

    Applying Rewards Participating Merchants Sign Up Rules

    This set of processes is used in order to apply the sign up rules specified on a rewards participating merchant. The following logic is applied:

    • On creating a new rewards participant or signing up a rewards participant to a new scheme
      • If the rewards participant sign up unit is a unit that is not represented by an effective or not effective rewards participating merchant then
        • The standard (existing) functionality is applied in order to award the customer event
      • If the rewards participant sign up unit is a unit that is represented by a not effective rewards participating merchant then
        • The reward participant is not allowed to be created
        • The reward participant is not allowed to join a new scheme
      • If the rewards participant sign up unit is a unit that is represented by an effective rewards participating merchant then
        • If the "Sign up new reward participants" is disabled then
          • The reward participant is not allowed to be created
        • If the "Sign up rewards participants owned by merchant's group to new schemes" is disabled and the rewards participant is owned by the merchant's group then
          • The reward participant is not allowed to join a new scheme
        • If the "Sign up rewards participants owned by other collaborating groups to new schemes" option is disabled and the rewards participant is owned by another collaborating group then
          • The reward participant is not allowed to join a new scheme
        • If the merchant is allowed to sign up existing reward participants to new specific schemes then
          • Only the schemes that the merchant can both use for sign up and is allowed to select can be added on reward participants
        • If the merchant is allowed to sign up existing reward participants to any new schemes then
          • Only the schemes that the merchant is allowed to select can be added on reward participants

    Applying Rewards Participating Merchants Contribution Rules

    This set of processes is used in order to apply the contribution rules specified on a rewards participating merchant. The following logic is applied:

    On performing the rewards settlement runs
  • The system retrieves only accounts receivable which are related with any effective or not effective rewards participating merchant
  • The system retrieves the purchase customer events that were not settled yet were performed by the specified merchant and were awarded
  • For each purchase customer event The system calculates the contribution percentage as follows:If there are contribution rules specified for that merchant thenThe system retrieves the contribution rule that has criteria that are fulfilled based on the characteristics of the purchase customer event

    When a Spend Request Customer Event is created, the following checks and actions are performed: 

    CASERESULT
    Spend Request is performed by a Unit that is not represented by a Rewards Participating Merchant.Spend Request is created normally.
    Spend Request is performed by a Unit that is represented by a 'Not Effective' Rewards Participating Merchant.

    Spend Request is not allowed.

    Spend Request is performed by a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    Submit Spend Requests on Behalf of Rewards Participants Owned By Merchant's Group is 'Disabled'
    AND
    Rewards Participant is related to the Spend Request is owned by the Merchant's Group.

    Spend Request is not allowed.

    Spend Request is performed by a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    Submit Spend Requests on Behalf of Rewards Participants Owned by Other Collaborating Groups is 'Disabled'
    AND
    Rewards Participant is related to the Customer Event is owned by another collaborating Group.

    Spend Request is not allowed.

     

    Applying Rewards Participating Merchants Sign Up Rules

    When a new Rewards Participant is created or assigned to a new Scheme, the following checks and actions are performed:

    CASERESULT
    Rewards Participant Sign up Unit is not represented by a Rewards Participating Merchant.The Rewards Participant is registered successfully.
    Rewards Participant Sign up Unit is represented by a 'Not Effective' Rewards Participating Merchant.
    • The Rewards Participant cannot be created.
    • The Rewards Participant is not allowed to join a new Scheme.
    Rewards Participant Sign up Unit is represented by an 'Effective' Rewards Participating Merchant
    AND
    Sign up New Rewards Participantsis 'Disabled'.
    • The Rewards Participant cannot be created.
    Rewards Participant Sign up Unit is represented by an 'Effective' Rewards Participating Merchant
    AND
    Sign up Rewards Participants Owned By Merchant's Group to New Schemes is 'Disabled' 
    AND
    Rewards Participant is owned by the Merchant's Group.
    • The Rewards Participant is not allowed to join a new Scheme.
    Rewards Participant Sign up Unit is represented by an 'Effective' Rewards Participating Merchant
    AND
    Sign up Rewards Participants Owned By Other Collaborating Groups to New Schemesis 'Disabled'
    AND
    Rewards Participant is owned by another collaborating Group.
    • The Rewards Participant is not allowed to join a new Scheme.
    Rewards Participant Sign up Unit is a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    Merchant is allowed to Sign up existing Rewards Participants to new specific Schemes.
    • Only the Schemes that the Merchant is allowed to select and that the Merchant can use for Sign up can be added on Rewards Participants.
    Rewards Participant Sign up Unit is a Unit that is represented by an 'Effective' Rewards Participating Merchant
    AND
    Merchant is allowed to Sign up existing Rewards Participants to any new Schemes.
    • Only the Schemes that the Merchant is allowed to select can be added on Rewards Participants.

    Applying Rewards Participating Merchants Contribution Rules

    When Rewards Settlement Runs are executed, the contribution that the Merchant is obliged to pay the Rewards platform is calculated. This amount is based on the Awards that have been granted.

    Note

    Contribution Rules can only be applied on the following Reward Offers:

    CASERESULT
    Contribution Rules are not setContribution is calculated to 100%.
    Contribution Rules are set

    For Purchase Customer Events

    1. If more than one rule is retrieved, then the one with the highest priority is
    used
    1. applied
    2. If there are contribution periods specified
    on
    1. in the
    retrieved
    1. rule and a period exists that covers the date that the
    purchase customer event
    1. Purchase Customer Event was performed
    exists
    1. then
      The merchant contribution percentage
        • Contribution Amount = Contribution % specified for that period
      is used
        • * awarded amount
          • else 
      The merchant contribution percentage
        • Contribution Amount = Contribution % specified on the rule
      is used
    2. Else
      • The contribution is set to 100%
    3. The amount that the merchant will be debited for is equal to the awarded amount multiplied by the contribution percentage
      • If the rewards participant currency is different than the merchant's currency then 
        • The amount is converted into the merchant's currency
    4. The system creates an invoice in the merchant's accounts receivable
        • * awarded amount  
      1. An Invoice is created in the Merchant's Accounts Receivable for the total amount that was
      calculated 
    5. The system retrieves the spend request customer events that were not settled yet and were performed y the specified merchant 
    6. For each spend request customer event The system calculates the amount that should
      1. calculated.

      For Spend Request Customer Events

      1. The amount to be credited, which is equal to the amount that the customer actually
      spend
      1. spent through
      its wallet
      • If the rewards participant currency is different than the merchant's currency then 
        • The amount is converted into the merchant's currency
      The system creates a credit note
      1. their wallet, is calculated
      2. A Credit Note is created in the merchant's
      accounts receivable
      1. Accounts Receivable for the total
      amount that was calculated
    7. Image RemovedCRMCOM-6014 - Handling award reward transactions and spend reward transactions that are cancelled after being settled CODE DESIGN The system processes any cancelled purchase or spend request customer events that were cancelled after being settled (see related process below)
    8. Applying Rewards Participating Merchants Crediting Rules

      This set of processes is used in order to apply the crediting rules specified on a rewards participating merchant. The following logic is applied:

      • When a Spend Reward Transaction is created
        • The system checks whether the Crediting Rules of the Rewards Participating Merchant who performs the event are enabled.
        • If Crediting rules are enabled then
          • The process validates that both the Credit Note financial transaction type and the Product that will be included in the Credit Note are defined in the Crediting Rule. If not defined, then no Credit Note is not created.
          • The process generates a new Credit Note based on:
            • The Accounts Receivable of the Rewards Participant for which the spend request customer event is submitted for.
            • The Credit Note financial transaction type of the Crediting Rule
            • The Product to be included in the Credit Note of the Crediting Rule
            • The amount of the product is set to equal to the Spend Reward Transaction's total amount which is generated based on the spend customer event.
              • It has to be noted that the Spend Customer Events is always generated using the system's default currency, whereas the spend reward transaction will be generated based on the rewards participant's preferred currency. The process ensure that the Credit Note will be generated based on the spend reward transaction's amount.
            • The Credit Note is also posted.
            • The Credit Note should be generated asynchronously
          • The process also creates a relation between the Credit Note and the Spend Reward Transaction
        • If Crediting rules are not enabled, then the rewards participant is not credited.
       
      1. calculated amount.
      Note

      In case that already settled Purchase or Spend Request Customer Events are cancelled, then the /wiki/spaces/WIP/pages/10008599 will consider them so that the Merchant's Accounts Receivable are debited or credited accordingly.

      • Cancelled Purchase Customer Event: Credit the Accounts Receivable
      • Cancelled Spend Request Customer Event: Debit the Accounts Receivable

      Handling Cancelled Purchase Customer Events and Spend Request Customer Events when Applying Rewards Participating Merchants Contribution Rules - 
      Status
      colourGreen
      titleAvailable from CRM.COM R10.1.0

      During the evaluation and application of the Contribution Rules, the System also performs checks for cancelled Purchase and Spend Request  Customer Events, so that the accounts of the Participating Merchants are debited or credited accordingly.

      The System will retrieve Purchase and Spend Request Customer Events that meet the following criteria:

      • Purchase Customer Events
        • That are related with a Rewards Participating Merchant ('Effective' or 'Not Effective')
        • That are already settled
        • That are cancelled
        •  Whose amount debited for that Merchant during the Settlement Process was not credited
      • Spend Request Customer Events
        • That are related with a Rewards Participating Merchant ('Effective' or 'Not Effective')
        • That are already settled
        • That are cancelled
        • Whose amount credited for that Merchant during the Settlement Process was not debited 
      CaseResult
      Cancelled Purchase Customer Event
      Note

      If no Contribution Rules are defined on the Merchant, then the System checks if the Merchant belongs to a Merchant Group. If the Merchant belongs to such a Group, then the Contribution Rules defined in the Merchant Group are taken into consideration.

       

      1. If there are Contribution Rules specified for that Merchant, then the rule with criteria that are fulfilled based on the characteristics of the Purchase Customer Event are retrieved.
      2. If more than one rule is retrieved, then the one with the highest priority is used.
        1. If there are contribution periods specified on the retrieved rule and a period that covers the date the Purchase Customer Event was performed on is present, then:
            • The Merchant contribution percentage specified for that period is used
          • else 
            • The Merchant contribution percentage specified on the rule is used
            else
            • The contribution is set to 100%.

      • The amount to be credited is calculated and is equal to the awarded amount multiplied by the Contribution Percentage.
      • A Credit Note is created against the Merchant's Accounts Receivable.
      • All the related Award Transactions are updated by referencing the Credit Note that settled them.
      Cancelled Spend Request Customer Event
      • The amount to be debited is calculated, which is equal to the amount that the customer spent through their Wallet
      • An Invoice is created against the Merchant's Accounts Receivable
      • All the related Spend Transactions are updated by referencing the Invoice that settled them.
      Panel
      namegrey

      Related Areas

      Filter by label (Content by label)
      showLabelsfalse
      spacesV4Manual
      showSpacefalse
      labelsrewards-basics-r7,rewards-advanced-r7,rewards-admin-r7

      Panel
      namegrey

      Helpful Links

      Filter by label (Content by label)showLabelsfalsespacesV4ManualshowSpacefalselabelsglobal