---
title: "Cancel an existing reward. By canceling the customer will have their points back. The reward will be in the canceled state."
method: DELETE
path: "/v1/pvt/POS/rewards/{id}"
tags: ["POS"]
---

# Cancel an existing reward. By canceling the customer will have their points back. The reward will be in the canceled state.

`DELETE /v1/pvt/POS/rewards/{id}`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/POS/rewards/{id}`
- Auth: HTTP basic

This endpoint requires to inform the Reward Id to be cancelled. This ID is the `RewardId` field received when calling the /rewards/{id}/redeem endpoint. 

Once cancelled an Reward cannot be "uncancelled". If needed it is necessary to create a new redeem request.

This endpoint returns the cancelled reward information.

## Path parameters

- `id` integer, required

## Response `200`

- BaseExternalApiResponseOfRewardRedeemedResponse: Standard response envelope used by the External API.
  - `ErrorMessage` string, nullable: Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect `Result`, `Code` and `Severity` first.
  - `ErrorCode` integer, nullable: Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use `ApiResponseErrorDescription`.
  - `Result` RewardRedeemedResponse
    - `Id` integer: Unique ID for this redeem
    - `Customer` CreateCustomerResponse
      - `OriginalId` string: This is the Id in the client store.
      - `PublicId` string, nullable: Bonifiq Plubic Id
      - `Name` string: Customer name.
      - `Email` string: Customer email.
      - `Phone` string, nullable: Customer Contact Phone.
      - `BirthdayDate` string, date-time, nullable: Customer Birthdate.
      - `SignupDate` string, date-time, nullable: Date when the customer made the register on client store.
      - `Document` string, nullable: Some document number from the customer, accepts any string.
      - `IsEnrolled` boolean: If true the customer is participating on the points plan from the store.
      - `ReferralURL` string, nullable: Customer`s Referral URL. Will be null if the Referral Objective is not active.
      - `WhatsappReferralUrl` string, nullable: Customer`s Referral URL for sharing in Whatsapp. Will be null if Referral Objective is not active
      - `CurrentTier` CustomerTierResponse
        - `Name` string
        - `Color` string
        - `IconUrl` string
      - `BalanceOfPoints` integer: Customer's current points balance
      - `BalanceCashback` number, nullable: Customer's current cashback balance (calculated from points). Will be null if cashback is not enabled.
      - `Segments` object[]: Active customer segments the customer belongs to (name and tag). Inactive segments are not returned. Empty list when the customer is not in any active segment. Populated by the customer endpoints (get, list, create, update, upsert and set birthday).
        - `Name` string: Segment name, as shown in the store's admin panel.
        - `Tag` string: Segment public identifier (slug, unique per store). Use it to reference the segment in integrations.
    - `ExternalCode` string: Unique external code for this redeem. Could be used for integrating with third-party systems
    - `CashValue` number, nullable: If it is a Cashback or Value rewards represents the amount in cash (R$) given for the customer
    - `IsCanceled` boolean: If true means this reward was cancelled and the points was given back to the customer
    - `RedeemDate` string, date-time: Date the reward was redeemed
    - `Points` RewardRedeemedReponsePoints
      - `Id` integer: Unique ID of the generated point
      - `Points` integer: How many points was used
      - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19: 0 = Purchase 1 = Signup 2 = Birthday 3 = Ordinary 4 = Reward 5 = Review 6 = Refund 7 = Expire 8 = Referral 9 = SocialMediaFollowFacebook 10 = SocialMediaFollowInstagram 11 = PartialOrderRefund 12 = Quiz 13 = CustomObjective 14 = ReferralAffiliate 15 = SocialMediaFollowLinkedin 16 = SocialMediaFollowTikTok 17 = Campaign 18 = Participation 19 = Fitness
      - `EventKey` string: Unique key for this record. Used to preventing duplication
  - `Code` string, nullable: Endpoint-specific business code formatted as a two-digit string, such as `03` or `07`. This field is available for success, warning and error outcomes.
  - `CodeName` string, nullable: Symbolic enum name associated with `Code`, such as `CheckoutNotFound`.
  - `Severity` 0 | 1 | 2: 0 = Success 1 = Warning 2 = Error
  - `HasWarning` boolean: Convenience flag that is `true` when `Severity` is `Warning`. Warnings are valid `200 OK` business outcomes and should not be handled as transport or validation errors.
  - `HasError` boolean: Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as `false`.

## Changes

- **2026-09-02** `ab5bc0ffd114`: 1 info
  - added the optional property `Result/oneOf[#/components/schemas/RewardRedeemedResponse]/Customer/oneOf[#/components/schemas/CreateCustomerResponse]/Segments` to the response with the `200` status

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/POS/rewards/:id/delete.md)

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)