Record user point event

POST

api/v1/rewards/user/{userKey}/points

Records a point transaction event for a user, updating their points balance.

Idempotency Key
Always generate a unique idempotencyKey per logical action
Reusing the same idempotencyKey will prevent duplicate point records

This is especially important when:

Retrying failed requests

Handling network timeouts

Processing webhook or background jobs

Best practice:
Use a UUID (e.g. 550e8400-e29b-41d4-a716-446655440000) as the idempotencyKey.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'api/v1/rewards/user/{{user-key}}/points' \
--header 'x-api-key:  {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "idempotencyKey": "{{$string.uuid}}",
  "companyId": "{{$string.uuid}}",
  "userKey": "{{$string.uuid}}",
  "pointId": "{{$string.uuid}}",
  "amount": {{$number.int(min=1,max=100000)}},
  "actionSource": 2,
  "actionType": 1
}'

Response Example

{"amount":92052,"pointId":"68e3ee00d81b74c5fe9ac28c","userKey":"1765133166042","pointName":"New Pointing system - 1759768062586"}

Modified at 2025-12-23 15:33:29

Overview

Get user points