BObonifiq
Reports

Returns a list of canceled cashback redemptions filtered by cancellation date.

Changed on

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.

get/v1/pvt/Reports/ListCanceledCashbackReport

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Query parameters

fromstring date-time

Start of the cancellation date range, in ISO 8601 with the offset. If omitted, the whole history is used

tostring date-time

End of the cancellation date range, in ISO 8601 with the offset. With a non-UTC offset it covers the whole day; with UTC or no offset the time sent is used as is. If omitted, the current UTC time is used

cancellationTypesinteger[] nullable

Optional cancellation types: Refresh (0), Removed (1), AbandonedCart (2), API (3), PDV (4) or MissingSecurityKey (5). Repeat the query parameter for multiple types, for example cancellationTypes=1&cancellationTypes=3. When cancellationTypes or includeUntyped is informed, only the selected cancellations are returned; when neither is informed, every cancellation is returned, including those without a type

includeUntypedboolean

Also returns cancellations without a type (CancellationType null). Send it without cancellationTypes to return only those. Default: false

customerOriginalIdstring nullable

Optional exact match on the customer's original ID from the source platform. Leading and trailing whitespace is ignored

pageNumberinteger

Page number, starting at 1 (default: 1). Values below 1 return HTTP 400

pageSizeinteger

Number of items per page (default: 10, max: 10000). Values below 1 return HTTP 400. A configured tenant report page size overrides this request

Response

Paginated list of canceled cashback redemptions

TotalItemCountinteger

Total of rewards Configurations founds.

PageSizeinteger

Pagination size

PageNumberinteger

Actual Page Number

HasNextPageboolean

true if there is another page to be load.

HasErrorboolean

If true the request had an error.

ErrorMessagesstring[]

List with the error messages

Changes

  • 07d830d32376Revision changes
    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • f30188727965Revision changes
    • info

      endpoint added