Give reward

POST /v1/public/customers/{customerId}/rewards

Issues one or more instances of an active merchant reward template to a customer. This operation requires an idempotency key.

Authorization

X-API-Key required with the customers:write scope

Parameters

Name	Location	Type	Required	Description
customerId	path	string	Yes	The customer'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
rewardId	string	Yes	Active merchant reward-template ID.
quantity	integer	No
locationId	string	No	Optional active merchant location responsible for the issuance.

Request example

curl -X POST "https://api.remyrewards.co.uk/v1/public/customers/66c735e253f2836fbe941235/rewards" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Idempotency-Key: order-1042-redeem-1" \
  -H "Content-Type: application/json" \
  --data '{
  "rewardId": "66c735e253f2836fbe941236",
  "quantity": 1,
  "locationId": "66c735e253f2836fbe941333"
}'

Responses

Status	Description
201	Reward issued.
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.