Claim a bonus reward. Deducts the required points from the customer's balance.
| HTTP Status | Error Code | Description |
|---|---|---|
| 403 | security_error | User is not authenticated |
| 400 | PARAMETER_ERROR | Missing or invalid bonus_id parameter |
| 403 | not_eligible | The customer's bonus group (customers.groupid) may not take part in this campaign (bonus.included_customertype / excluded_customertype) |
| 400 | not_enough_points | Customer does not have enough points for the reward |
| 400 | wrong_reward | The specified reward does not exist for this campaign, or (without reward_id) the campaign has no reward valid today |
| 400 | not_current | The reward's period (start_date / end_date) does not cover today |
| 400 | pending | The specified reward was already requested and must first be processed by the backend, before it can be applied for again. |
Result of a bonus action (apply, claim or admin set)
| # | Field | Type | Description |
|---|---|---|---|
| 0 | action | string | the action that was performed |
| 1 | result | string | the exit/result code of the action |
Data (1 record)
| action | result |
|---|---|
| Bonus | security_error |