A list of reasons for rejecting the voucher transaction
Make sure to check Errors page before proceeding!
When the redemption of the voucher is unsuccessful and you receive a 422 error, regardless of whether you perform a Create a Redemption or Validate the Voucher request, we add a message that will help you to find out why the conditions weren't fulfilled and redemption of the voucher rejected. Certain errors incorporate supplementary information referred to as 'code,' which can be relied upon when managing errors.
{
"type": "error",
"error": true,
"code": "redemption_rejected",
"message": "Voucher assigned to a different customer",
"errors": [
{
"code": "1003",
"message": "Voucher assigned to a different customer"
}
]
}
There may be various reasons why a voucher redemption request is denied, related to:
VOUCHER CODE AND ITS RESTRICTIONS:
Message | Code | Description |
---|---|---|
Voucher is expired | 1001 | the voucher used in the redemption request is not valid anymore |
Voucher has already been used or it is temporarily blocked. No redemptions left | 1002 | this voucher has been redeemed or is reserved for another transaction, and doesn't have any more redemptions left |
Voucher assigned to a different customer | 1003 | the voucher is assigned to another Customer ID, and only that Customer ID can redeem it |
Voucher is not active | 1004 | the voucher used in the redemption request is not active |
No money left on gift card | 1005 | all gift card credits have been fully utilized |
Voucher is assigned to a customer, but customer_identifier was not provided | 1006 | the voucher is assigned to Customer ID, but Customer Id is not provided |
TRANSACTIONS AND ITS RESTRICTIONS:
Message | Code | Description |
---|---|---|
Order value is lower than the required minimum value for the campaign | 2001 | the minimum order value set for this promotion hasn't been reached |
Total transaction cost is not equal to the sum of products cost | 2002 | there is a discrepancy in the request information that has to be solved before proceeding |
Redemption with that transaction id exists | 2003 | the redemption id already exists in our system |
CAMPAIGN ASSOCIATED WITH THE VOUCHER AND ITS RESTRICTIONS:
Message | Code | Description |
---|---|---|
Campaign is finished | 3001 | the promotional campaign associated with the voucher code has ended. |
Campaign is not active | 3002 | the promotional campaign associated with the voucher code has been inactivated |
Parent campaign not found | 3003 | the main campaign of the voucher's promotion is missing |
max redemptions limit reached | 3004 | the campaign has already reached the maximum number of redemptions set for this promotion |
max budget limit reached | 3005 | the promotion's maximum budget has already been reached by the campaign. |
Max redemptions limit for voucher reached | 3006 | the number of redemptions set for the voucher has been fulfilled |
Max budget limit for voucher reached | 3007 | the maximum budget spent for this voucher code has been reached |
PROMOTION RULES AND RESTRICTIONS:
Message | Code | Description |
---|---|---|
Additional categories rule wasn't satisfied | 4001 | there are additional categories (related to the transaction) set for this campaign that weren't satisfied or are missing |
Customer categories rule wasn't satisfied | 4002 | the promotion is restricted to a specific Customer segment and the Customer ID passed in the request is not included in that segment |
Customer max redemptions rule wasn't satisfied | 4003 | the Customer has redeemed this particular promotion already and is not eligible for additional redemptions (regardless of whether it's a unique or generic voucher) |
Customer loyalty points rule wasn't satisfied | 4004 | the promotion is restricted to Customers with a specific number of minimum loyalty points and the points allocated for the Customer ID passed in the request did not meet this criteria |
no products satisfy product category rule | 4005 | the transaction does not contain any product categories that meet the requirements for the promotion to be valid, or there may be missing product information. |
product items rule wasn't satisfied | 4006 | the transaction does not contain any products that meet the requirements for the promotion to be valid, or there may be missing product information. |
basket items rule wasn't satisfied | 4007 | the transaction does not contain any basket items, that are required to be included in the purchase transaction for the promotion to be valid (eg. Buy 2, get 1 Free) or there may be missing product information. |
time of order rule wasn't satisfied | 4008 | this means there is a rule that requires the transaction to be performed within a certain time frame (for instance, during lunchtime), and that timeframe wasn't met |
timeframe rule wasn't satisfied | 4009 | the rule that specifies when the campaign starts and when it ends wasn't fulfilled (for instance, the campaign hasn't started yet) |
unknown rule | 4010 | an unknown rule has been created for the campaign |
Here are the codes in the text file:
Voucher is expired
Voucher has already been used or it is temporarily blocked. No redemptions left
Voucher assigned to a different customer
Voucher is assigned to a customer, but customer_identifier was not provided
Voucher is not active
Order value is lower than the required minimum value for the campaign
Total transaction cost is not equal to the sum of products cost
Campaign is finished
Campaign is not active
Parent campaign not found
max redemptions limit reached
max budget limit reached
max redemptions limit for voucher reached
max budget limit for voucher reached
Additional categories rule wasn't satisfied
Customer categories rule wasn't satisfied
Customer max redemptions rule wasn't satisfied
Customer loyalty points rule wasn't satisfied
no products satisfy product category rule
product items rule wasn't satisfied
basket items rule wasn't satisfied
time of order rule wasn't satisfied
timeframe rule wasn't satisfied
Transaction with that transaction id exists
Redemption with that transaction id exists
unknown rule