--- title: "Returns a list of canceled cashback redemptions filtered by cancellation date." method: GET path: "/v1/pvt/Reports/ListCanceledCashbackReport" tags: ["Reports"] --- # Returns a list of canceled cashback redemptions filtered by cancellation date. `GET /v1/pvt/Reports/ListCanceledCashbackReport` ## Request - Base URL: `https://api.bonifiq.com.br` - URL: `https://api.bonifiq.com.br/v1/pvt/Reports/ListCanceledCashbackReport` - Auth: HTTP basic A canceled cashback redemption gives the points back to the customer. Most cancellations happen in the checkout (cashback removed, checkout updated or abandoned). Use cancellationTypes and includeUntyped to select only the cancellations you need. Redemptions without a cancellation date are not returned. Each item has the same fields as the Reward_Cancelled webhook payload, so the same model can read both, plus CancellationTypeDescription, Customer.InternalId, BranchOriginalId, BranchName and TenantSalesmanName. Differences: Customer.Rfm is not returned, and PointsBalance and Customer.PointsBalance hold the current balance of the customer, not the balance at the moment of the cancellation. ## Cancellations without a type CancellationType is null when no type was recorded: cancellations from before mid-2025 (when the type started being recorded), refunds of canceled orders, replacement redemptions canceled when the original one was restored, and some integration and internal flows. Use includeUntyped to select them. ## Dates from and to filter CancelledDate. Send them in ISO 8601 with the offset, for example 2026-10-01T00:00:00-03:00. With a non-UTC offset, from and to cover whole days in that offset: from=2026-10-01T00:00:00-03:00 and to=2026-10-01T00:00:00-03:00 return every cancellation of October 1 in Brasília time. Dates without an offset are read in the server time zone, which is UTC. With UTC or no offset, to is used exactly as sent, so a date at midnight does not include the rest of that day: from=2026-10-01 and to=2026-10-01 return nothing. If from is omitted, the whole history is used. If to is omitted, the current UTC time is used. Dates in the response are in UTC. Data comes from the analytics database and may take a few hours to reflect recent cancellations. Items are ordered by CancelledDate descending, then Id descending. ## Query parameters - `from` string, date-time - `to` string, date-time - `cancellationTypes` integer[], nullable - `includeUntyped` boolean - `customerOriginalId` string, nullable - `pageNumber` integer - `pageSize` integer ## Response `200` Paginated list of canceled cashback redemptions - BaseExternalApiListResponseOfReportCanceledCashbackResponse: Base List response model methods - `Items` object[], nullable: Collection with the found entities on the bonifiq DB. - `RewardId` integer: Id of the redemption. The same RewardId of the Reward_Redeemed and Reward_Cancelled webhooks and of the /v1/pvt/Rewards/{id} endpoints - `RewardConfigurationId` integer: Id of the configured reward - `RewardType` 0 | 1 | 2 | 3 | 4 | 5: 0 = PercentDiscountCoupon 1 = ValueDiscountCoupon 2 = FreightDiscountCoupon 3 = PointToCashback 4 = Customized 5 = ProductDiscount - `CouponCode` string, nullable: Coupon code generated by the redemption (null when the redemption does not generate a coupon) - `ExternalCode` string, nullable: External code of the redemption - `PointId` integer: Id of the points transaction of the redemption - `Points` integer: Points of the redemption given back to the customer - `CashValue` number, nullable: Cashback value of the redemption, in currency - `RedeemDate` string, date-time: Date when the customer redeemed the cashback (ISO 8601, UTC) - `RedeemOrigin` 0 | 1 | 2 | 3 | 4 | 5: 0 = LandingPage 1 = Widget 2 = Copilot 3 = Checkout 4 = API 5 = PDV - `Customer` ReportCanceledCashbackCustomer: Customer of a canceled cashback redemption, with the same fields as the webhook Customer object (except Rfm) - `Email` string, nullable: Customer email - `Id` string, nullable: Customer Id in the client store (OriginalId), as in the webhook - `InternalId` string, nullable: ID for this customer on the Bonifiq DB (PublicId). Not present in the webhook - `Name` string, nullable: Customer name - `Phone` string, nullable: Customer phone - `Document` string, nullable: Customer document (CPF/CNPJ) - `BirthdayDate` string, date-time, nullable: Customer birthday - `PointsBalance` integer: Current points balance of the customer (not the balance at the moment of the cancellation) - `PointsBalance` ReportCanceledCashbackPointsBalance: Current points balance of the customer - `PointsBalance` integer: Current points balance - `CashbackBalance` number: Current balance converted to cashback with the active cashback reward, in currency (0 when there is none) - `CancelledDate` string, date-time: Date when the cashback redemption was canceled (ISO 8601, UTC) - `CancellationType` 0 | 1 | 2 | 3 | 4 | 5: 0 = Refresh 1 = Removed 2 = AbandonedCart 3 = API 4 = PDV 5 = MissingSecurityKey - `CancellationTypeDescription` string, nullable: Description of the cancellation type. Not present in the webhook - `BranchOriginalId` string, nullable: Branch Id in the client store, when the redemption was made in a branch. Not present in the webhook - `BranchName` string, nullable: Branch name, when the redemption was made in a branch. Not present in the webhook - `TenantSalesmanName` string, nullable: Salesman name, when the redemption was made by a salesman. Not present in the webhook - `TotalItemCount` integer: Total of rewards Configurations founds. - `PageSize` integer: Pagination size - `PageNumber` integer: Actual Page Number - `HasNextPage` boolean: true if there is another page to be load. - `HasError` boolean: If true the request had an error. - `ErrorMessages` string[]: List with the error messages ## Changes - **2026-10-22** `07d830d32376`: 7 warning, 7 info - removed the optional property `Items/items/oneOf[#/components/schemas/ReportCanceledCashbackResponse]/CustomerDocument` from the response with the `200` status - removed the optional property `Items/items/oneOf[#/components/schemas/ReportCanceledCashbackResponse]/CustomerEmail` from the response with the `200` status - removed the optional property `Items/items/oneOf[#/components/schemas/ReportCanceledCashbackResponse]/CustomerInternalId` from the response with the `200` status - removed the optional property `Items/items/oneOf[#/components/schemas/ReportCanceledCashbackResponse]/CustomerName` from the response with the `200` status - …10 more - **2026-10-22** `f30188727965`: 1 info - endpoint added [Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Reports/ListCanceledCashbackReport/get.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)