BObonifiq
POS

Cancel an existing reward using the OriginalKey

Changed on

This endpoint requires to inform the OriginalKey to be cancelled. This the same 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.

delete/v1/pvt/POS/rewards

Request

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

Request body

OriginalKeystring

The same OriginalKey used upon redeeming

Response

ErrorMessagestring 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.

ErrorCodeinteger nullable

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Codestring 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.

CodeNamestring nullable

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity0 | 1 | 2

0 = Success 1 = Warning 2 = Error

HasWarningboolean

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.

HasErrorboolean

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

  • ab5bc0ffd114Revision changes
    • info

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