Adjust voucher balance

POST /v1/public/vouchers/{id}/adjust

Sets a customer voucher's remaining value and records an immutable adjustment reason. The value cannot exceed the original value. This operation requires an idempotency key.

Authorization

X-API-Key required with the vouchers:manage scope

Parameters

Name	Location	Type	Required	Description
id	path	string	Yes	The customer voucher's returned id or externalId.
Idempotency-Key	header	string	Yes	A unique key for this logical write operation. Keys are retained for 24 hours.

Request body

Field	Type	Required	Description
remainingValue	number	Yes	New absolute remaining balance; it cannot exceed the issued value.
reason	string	Yes	Human-readable audit reason.

Request example

curl -X POST "https://api.remyrewards.co.uk/v1/public/vouchers/66c735e253f2836fbe941234/adjust" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Idempotency-Key: order-1042-redeem-1" \
  -H "Content-Type: application/json" \
  --data '{
  "remainingValue": 20,
  "reason": "Till correction REF-1042"
}'

Responses

Status	Description
200	Voucher balance adjusted.
400	The request is missing a required value or contains invalid data.
401	The API key is missing or invalid.
403	The API key is valid but does not have the required scope.
404	The requested integration resource was not found.
409	The idempotency key is already processing or was used for a different request.
429	A rate or concurrency limit was exceeded.