Cancel Points API

This API allows you to cancel previously issued points for one or more recipients using their unique identifier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Schema

PropertyTypeDescription
recipients_data.recipientsarrayList of recipients for whom points cancellation is requested.
recipients_data.recipients[].unique_idnumberUnique transaction ID of the points issuance that needs to be cancelled.

Response Schema

PropertyTypeDescription
data.cancelBalance.errorbooleanIndicates whether the cancellation operation failed (false = success).
data.cancelBalance.messagestringSummary message describing the overall cancellation result.
data.cancelBalance.recipientsarrayList of point transactions processed in the cancellation request.
data.cancelBalance.recipients[].unique_idnumberUnique transaction ID of the points issuance.
data.cancelBalance.recipients[].successbooleanIndicates whether the transaction cancellation was successful.
data.cancelBalance.recipients[].messagestringTransaction-level status message explaining the outcome of the cancellation.
Body Params
string
Defaults to storesAdmin.mutation.cancelBalance
string
Defaults to storeAdmin
variables
object
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json