v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Revoke User Reward

post/api_gateway/rewards/core/v1/user/reward/revoke

Query parameters

usernamestring

Store identifier used for gateway authentication.

Headers

Authorizationstring

X-CAP-API-OAUTH-TOKENstring

Request body

txnIdinteger required

Transaction ID of the issuance transaction to revoke.

revokedEventDateTimestring

Source event date-time in ISO 8601 format. Defaults to the processing time.

revokedBystring

Actor who initiated the revoke.

revokeReasonstring

Reason for revoking the reward.

Example request

{
  "txnId": 9876543210,
  "revokedEventDateTime": "2026-05-13T09:32:11.000Z",
  "revokedBy": "BRAND_OPERATOR",
  "revokeReason": "VENDOR_FULFILMENT_FAILURE"
}

Response

Outcome of the revoke. The result is conveyed in the status object.