AwardIt Gift Card
Configure AwardIt gift card payment provider with Omnium for gift card redemption.
AwardIt Gift Card Integration with Omnium
Omnium supports AwardIt for gift card payment processing, enabling full gift card lifecycle management including creation, balance checking, and redemption.
Supported Features
- Create gift cards with email/SMS distribution
- Check balance and validity
- Authorize (reserve) gift card funds
- Capture reserved amounts
- Cancel reservations
- Credit/Refund to gift cards
Setup Instructions
Configuration Path
-
Navigate to:
Configuration > Settings > Payment > Payment Types > "..." > Add -
Fill out the required fields as outlined below.
Required Fields
| Field | Description | Value |
|---|---|---|
| Unique Payment Name | The unique identifier for the AwardIt payment method. | AwardIt |
| Payment Service | The name of the payment service used for this configuration. | AwardIt |
| Provider Name | Specifies which provider to use. | AwardIt |
| Display Name | The name shown in the Omnium interface. | Gift Card or your preferred name |
| Client ID | Your AwardIt OAuth2 Client ID. | Your Client ID from AwardIt |
| API Token | Your AwardIt OAuth2 Client Secret. | Your Client Secret from AwardIt |
| Base URL | AwardIt API endpoint URL. | Your AwardIt API URL |
Optional Configuration
| Field | Description |
|---|---|
| Authorization Time (Days) | Days until gift card reservation expires |
| Display in Cart | Show gift card option in checkout |
Template Configuration (Properties)
Configure gift card templates per market:
| Property | Description |
|---|---|
DefaultTemplate | Default template ID when no market match |
TemplateForMarket_{marketId} | Market-specific template ID |
DistributionTypeForMarket_{marketId} | Distribution method: Email or Sms |
Example:
Supported Operations
| Operation | Supported | Notes |
|---|---|---|
| Create Gift Card | Yes | With email or SMS distribution |
| Get Balance | Yes | Including validity and reserved amounts |
| Search Gift Card | Yes | Find cards by code |
| Authorize | Yes | Reserve funds with optional PIN |
| Capture | Yes | Capture reserved amount |
| Cancel | Yes | Release reserved funds |
| Release Remaining | Yes | Release uncaptured portion |
| Refund | Yes | Add funds back to card |
Special Features
Gift Card Creation
Gift cards can be created and distributed via:
- Email: Card details sent to recipient email
- SMS: Card details sent via text message
Configuration per market determines distribution method.
PIN Protection
Gift cards can optionally require a PIN for authorization:
- PIN provided during payment
- Validated by AwardIt during reservation
- Stored securely with the card
Balance Information
When checking gift card balance:
| Field | Description |
|---|---|
| Available Balance | Funds available for use |
| Reserved Amount | Funds held pending capture |
| Captured Amount | Funds already used |
| Valid From | Card activation date |
| Valid Through | Card expiration date |
Authorization Expiration
Reservations can have configurable expiration:
- Set via
AuthorizationTimeInDayssetting - If > 0, sets
ValidThruon reservation - Expired reservations automatically release funds
Over-Authorization Prevention
The system prevents reserving more than the order allows:
- Compares against non-gift-card reserved amounts
- Ensures total reservations don't exceed order total
Gift Card Flow
Issuance Flow
- Configure template ID (per market or default)
- Determine distribution type (Email/SMS)
- Create card with amount and recipient details
- Card code and details returned
- Distribution sent to recipient
Payment Flow
- Customer enters gift card code (and PIN if required)
- Balance checked for availability
- Funds reserved for order amount
- On order completion, funds captured
- Remaining balance available for future use
Refund Flow
- Return processed in Omnium
- Refund amount sent to AwardIt
- Funds added back to gift card balance
- Card balance updated
Error Handling
AwardIt errors are displayed on the order in the Errors section.
Common Error Scenarios
| Scenario | Resolution |
|---|---|
| Insufficient balance | Check card balance before authorization |
| Card expired | Card validity period has ended |
| Invalid PIN | Verify PIN matches card |
| Card not found | Check gift card code |
Configuration Reference
Payment Service
AwardIt
Authentication
OAuth2 Client Credentials flow with JWT token caching
Amount Format
Decimal strings with 2 decimal places (e.g., "99.99")