Bonus Points

Bonus Points Integration with Omnium

Omnium supports Bonus Points as a payment method, allowing customers to redeem loyalty points from their customer club membership as payment for orders.

Supported Features

• Authorize (reserve) bonus points
• Capture redeemed points
• Cancel point reservations
• Credit/Refund points back to customer
• Release remaining uncaptured authorization

---

Setup Instructions

Configuration Path

1. Navigate to: Configuration > Settings > Payment > Payment Types > "..." > Add

2. Fill out the required fields as outlined below.

---

Required Fields

---

Optional Configuration

---

Supported Operations

---

How It Works

Point Reservation Flow

1. Authorization: Points are reserved from the customer's available balance

   • Customer's CurrentBalance decreases
   • Customer's ReservedPoints increases
   • Transaction recorded with status "OnHold"

2. Capture: Reserved points are finalized as redeemed

   • Points moved from reserved to captured state
   • Customer's bonus points balance updated

3. Cancellation: If needed, reserved points return to available balance

   • ReservedPoints decreased
   • CurrentBalance restored

Refund Flow

When processing returns, points are credited back to the customer:

• Available credit amount is validated
• Points added back to customer's CurrentBalance
• Cannot credit more than originally authorized

Partial Capture

For partial fulfillment scenarios:

• Capture only the points for shipped items
• Use "Release Remaining Auth" to return uncaptured points to customer

---

Customer Club Integration

Bonus Points payment integrates with the Omnium Customer Club system:

Point Balance Structure

Point Earning Interaction

When orders are paid partially with bonus points:

• Points earned on bonus-paid items are reduced proportionally
• Items paid with other payment methods earn full points
• If entire order paid with bonus points, no new points earned

---

Usage Scenarios

Scenario 1: Full Bonus Point Payment

1. Customer has 500 points available
2. Order total: 500 points equivalent
3. Authorization: 500 points reserved
4. Capture: 500 points redeemed
5. Final balance: 0 points

Scenario 2: Partial Payment

1. Customer has 300 points
2. Order total: 500 points equivalent
3. Customer uses 150 points + credit card
4. Authorization: 150 points reserved
5. Capture: 150 points redeemed
6. Customer earns points on the card-paid portion

Scenario 3: Return with Points

1. Original order: 100 points redeemed
2. Customer returns 50% of items
3. Credit: 50 points refunded
4. Customer balance increases by 50 points

---

Validation Rules

Authorization

• Customer must have active club membership
• Sufficient points must be available
• Order must have line items

Credit/Refund

• Cannot credit more than AvailableAmountToCredit
• Order must exist
• Active payment must be found

Release Remaining

• Only releases if remaining amount > 0
• Calculates from total authorized minus captured

---

Error Handling

Common Error Messages

---

Configuration Reference

Payment Service

BonusPoints

Prerequisites

• Customer Club module enabled
• Customer has active membership
• Points balance tracking configured