Awardit Voucher Adapter
Overview Document: Payment Adapters Overview
Overview and Unique Capabilities
The Awardit Adapter integrates Awardit gift cards and loyalty rewards with Norce Checkout. This page focuses on the unique technical details and configuration for Awardit.
Voucher Operations Supported
- Gift card validation and balance check
- PIN/secret digits verification (when required by card configuration)
- Multiple gift cards per order (split payment across cards)
- Automatic amount calculation based on remaining order total
- Real-time balance updates when cart or shipping changes
Limitations
- Partial Capture is not supported (gift cards are redeemed in full for the covered amount).
- Partial Refund is not supported.
- Authorization expires after 24 hours.
- Card currency must match order currency.
- Only
redeemOnOrderCompletedcapture mode is currently supported.
Configuration in Norce Admin
The adapter is configured using the following unique details obtained from Awardit:
| Field | Description | Example Value |
|---|---|---|
baseUrl | Awardit API URL (test or production environment). | https://api.awardit.com |
username | Your Awardit API username. | your-username |
password | Your Awardit API password. | your-password |
shopId | Your Awardit shop identifier. | 12345 |
Optional Configuration
| Field | Description | Default |
|---|---|---|
voucherCaptureMode | Defines when the gift card reservation is redeemed. | redeemOnOrderCompleted |
Voucher Capture Mode
The Awardit Adapter uses a two-phase commit pattern for gift card redemption:
Authorization Phase: When the order moves to Processing state, the adapter authorizes (reserves) the gift card amount with Awardit. This reservation expires after 24 hours.
Commit Phase: When the order moves to Completed state, the adapter commits the reservation, permanently deducting the amount from the gift card balance.
If the order returns to Checkout state before completion, the authorization is automatically released, making the funds available on the gift card again.
Adding a Gift Card Payment
To add a gift card to an existing Norce Checkout order:
POST /api/checkout/v1/orders/{order_id}/payments
Host: {slug}.api-se.stage.norce.tech
x-merchant: {merchant}
x-channel: {channel}
Authorization: Bearer {token}
Content-Type: application/json
{
"cardId": "3141592653589793",
"code": "23846"
}The code field contains the PIN/secret digits and is optional depending on the card configuration.
The PIN code (secret digits) is not validated when adding the card. The adapter only checks if a PIN is required based on the card configuration. The actual PIN validation occurs when the order moves to Processing state and the adapter attempts to authorize the payment.
Using Multiple Gift Cards
Customers can add multiple gift cards to cover an order total. Each card covers a portion of the remaining balance. The adapter automatically calculates the optimal amount for each card based on the remaining uncovered order total.
Removing a Gift Card
To remove a gift card from an order:
POST /api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove
Host: {slug}.api-se.stage.norce.tech
x-merchant: {merchant}
x-channel: {channel}
Authorization: Bearer {token}This performs a soft delete, setting the payment state to removed. If the payment was already authorized (Reserved state), the adapter automatically releases the authorization with Awardit.
Troubleshooting (Awardit Specific)
In addition to the generic troubleshooting steps:
- Verify the gift card status directly with Awardit if needed.
- Check the Norce order payment state and attributes for error details.
- Review the payment transactions on the order for an audit trail of all operations.
Error Codes
| Error Code | Description |
|---|---|
awardit-card-not-found | The gift card does not exist |
awardit-missing-pin | PIN code required but not provided |
awardit-card-empty | Card balance is zero or negative |
awardit-validation | General validation error (e.g., currency mismatch) |
payment-conflict | Card already added to this order |
Links and References
- Awardit Adapter OpenAPI Specification
- Awardit Developer Documentation (contact Awardit for API documentation)