SolutionsPricingDocsStart Free
Api

Void Reward

POST
/v1/rewards/{rewardId}/void

Void an earned Reward with a reason code and a reason. A void is final; the Reward stays in the history. A write applies at once. Needs the rewards:void key permission.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Path Parameters

rewardId*string
Match\S
Length1 <= length <= 512

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/rewards/string/void" \  -H "Content-Type: application/json" \  -d '{    "operationKey": "string",    "reasonCode": "fraud",    "reason": "string",    "projectId": "string"  }'
{  "success": true,  "data": {    "voidId": "string",    "rewardId": "string",    "reasonCode": "fraud",    "reason": "string",    "actor": "string",    "voidedAt": "string"  }}