Public API GatewayAbstractions Reference
Guides
Help CenterAsk a Dev

Payments

Suggest Edits

<Payments> is the element that goes into a result to say you want to pay somebody something. There are not multiple payments. Every time you wish to make a payment, you have to do a <payment> tag to say what the bonus name is, what pool it's coming from, and a tag and metadata if you want to use that. Payments always take a group and a source. 

<Rule Description="Team Commission" Name="TC">
    <And>
        <MeetsRule Rule="A"/>
    </And>
    <Result>
        <Payments>
            <Payment Pool="MasterPool" Bonus="Team Commission" Tag="" MetaData="">
                <Group>
                    <CurrentAssociateGroup/>
                </Group>
                <Source>
                    <WeakLegVolumePay TreeVolume="BCV" PercentPay="15" WeakLegVolume="200" StrongLegVolume="400" TotalMaxVolume="133600" Comment="Lessor Leg"/>
                </Source>
            </Payment>
        </Payments>
    </Result>
</Rule>

Within a <Rule>, the <Payments> element defines:

  • What requirements are necessary to earn a payment
  • The group of Associates that contribute volume to the payment
  • The details of how much to pay
<Rule Name="EB" Description="Early Bird order bonus">
  <And>
    <MeetsRule Rule="Active" />
    <PVCondition Volume="Retail-Orders" Min="2" Max="-1" />
  </And>
  
  <Result>
    
    <Payments>
      <Payment Pool="MasterPool" Bonus="EB bonus" Tag="" MetaData="">
        
        <Group>
          <CurrentAssociateGroup />
        </Group>
        
        <Source>
          <FixedAmountPay Amount="5" Comment="Early Bird Bonus" GroupSize="0" OneTimeKey="" />
        </Source>
      </Payment>
      
    </Payments>
    
  </Result>
</Rule>

In the preceding example, the first qualification is to be "Active" (<MeetsRule Rule="Active" />).

Next, they must have Volume of 2 (Min="2") in "Retail-Orders" (<PVCondition Volume="Retail-Orders" Min="2" Max="-1" />). This references a Volume that you have to define earlier in the template:

<Retail Name="Retail-Orders" VolumeRange="First7DaysOfTheMonth">
  <VolumeType>
    <DefVolType VolumeGroup="OrderCount" />
  </VolumeType>
</Retail>

For this example, orders are placed by Retail Associates under a Distributor in the first week of the month. Finally, if those conditions are met, the result is a $5 payment:

<Source>
          <FixedAmountPay Amount="5" Comment="Early Bird Bonus" GroupSize="0" OneTimeKey="" />
</Source>

Payment Pools

Payment Pools are used to make payments. Every time you'll do a payment, you'll use a Payment Pool to say where is this money coming from? In a lot of cases, you could have multiple payment pools. All payments have to come from a Source or a Pool.

<Pools>
      <GVPaymentPool Name="MasterPool" TreeVolume="GroupVolume" GVPercent="100"  /> 
</Pools>

To set up a Pool:

  1. Define the <Pool> (<GVPaymentPool />).
  2. Name the <Pool> (Name="MasterPool").
  3. Reference a <TreeVolume> (TreeVolume="GroupVolume").
  4. Specify what percent of the volume will be used for this <Pool> ( GVPercent="100").

The GVPercent is the percentage of the TreeVolume this Pool can use to make payments.

For example:

<Pools>
    <GVPaymentPool GVPercent="45" TreeVolume="TS" Name="MasterPool" />
</Pools>

This example gets the "TS" Tree Volume (or group volume) and expects to pay 45% of the company's group volume.

There is a selection of different Pools to use:

  • <GVPaymentPool>
  • <CappedPool>

<GVPaymentPool> is just for informational purposes. You can use a <CappedPool>, which will hard-code the percentage, not allowing clients to go over that percentage.

Payment Groups

Groups are who you are getting paid on.

<Group>
    <CurrentAssociateGroup />
</Group>

Payment Filters

Payment filters are the same idea as Payments. A payment filter filters the group of people. The example we have right here is saying, give me everybody on my level one of the Enrollment Tree.

Then you have this <HasStat> option, which is "not Distributor". So give me everybody on my level one that is a retail customer is what the following example is saying: 

<Group>
    <HasStat Option="RC">
        <Group>
            <GenerationGroup Tree="Enrollment" Generation="1" CompressOption="" BeginLevel="1"/>
        </Group>
    </HasStat>
</Group>

Payment Sources

There are a couple of different payment sources, but let's focus on WeakLegVolumePay. Suppose you have your volume: 500 on your Right and 1000 on your Left. There are two different ways they will pay in this instance:

  1. You'll get a percentage of your Weak Leg. So, if your Weak Leg is 500, you get 10% (50). When that happens, it's going to remove that volume from the Weak Leg. Most likely, it will remove either an equal amount in your Strong Leg or more. And that's what you get paid on.

    Even though it's called a WeakLegVolumePay, in most cases, you're getting paid based on volume in both Legs.

  2. Cycle Pay. If you have 500 on your Weak Leg and 1000 on your Strong, a Rule may say you need 250 on your Weak Leg and 500 volume on your Strong. Every time you do that, you get $25.

WeakLegVolumePay accomplishes both of those payment types. It just depends on how you set it up: 

<WeakLegVolumePay TreeVolume="BCV" PercentPay="15" WeakLegVolume="200" StrongLegVolume="400" TotalMaxVolume="133600" Comment="Lessor Leg" />

In this example, you can see they have a WeakLegVolume of "200" and a StrongLegVolume of "400". So this example is doing a Cycle Pay. Every time you get 200 on Weak and 400 on Strong, you get 15% of the WeakLegVolume paid out to me (200 * .15). The TotalMaxVolume says they can only cycle X amount of times; this is the total amount of volume that can be removed from your Weak Leg.

Your payments can be made off a <CurrentAssociateGroup /> instead of individuals.

Downline Payments

Associates can earn a percentage of their downline's volume.

For example, if you are Silver Rank:

<Rule Name="SB" Description="Lvl 1 Silver">
  <And>
    <MeetsRule Rule="Silver" />
  </And>
  
  <Result>
    
    <Payments>
      <Payment Pool="MasterPool" Bonus="Lvl1 Silver Bonus" Tag="" MetaData="">
        <Group>
          <GenerationGroup Tree="Unilevel" Generation="1" CompressRule="" BeginLevel="1" />
        </Group>
        
        <Source>
          <PVPay Volume="QualifiedVolume" Percent="10" Comment="[backofficeId] ([percent]% of [acrVolume])" />
        </Source>
      
      </Payment>
    </Payments>
    
  </Result>
  
</Rule>

You will get ten percent (Percent="10") of Personal Volume from the people your Generation 1:

<Group>
  <GenerationGroup Tree="Unilevel" Generation="1" CompressRule="" BeginLevel="1" />
</Group>

If you are Gold Rank:

<Rule Name="GB" Description="Lvl 2 Gold">
  <And>
    <MeetsRule Rule="Gold" />
  </And>
  
  <Result>
    <Payments>
      <Payment Pool="MasterPool" Bonus="Lvl2 Gold Bonus" Tag="" MetaData="">
        
        <Group>
          <GenerationGroup Tree="Unilevel" Generation="2" CompressRule="" BeginLevel="1" />
        </Group>
        
        <Source>
          <PVPay Volume="QualifiedVolume" Percent="5" Comment="[backofficeId] ([percent]% of [QualifiedVolume])" />
        </Source>
      
      </Payment>
    </Payments>
    
  </Result>
  
</Rule>

You will get five percent (Percent="5") of Personal Volume from your Generation 2:

<Group>
  <GenerationGroup Tree="Unilevel" Generation="2" CompressRule="" BeginLevel="1" />
</Group>

You can define a percentage for each Generation.

Updated almost 4 years ago