Adjust a points balance

POST/v1/points/adjustments

Credits or debits a player's balance by hand and records why. Idempotent per player when an idempotency key is supplied, a retry returns the original adjustment instead of moving the balance again.

Authorization

ApiKey

AuthorizationBearer <token>

Paste a project API key (no 'Bearer ' prefix). Create one in the dashboard under API keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for an adjustment. The project environment is not part of the body, it is resolved from the API key.

playerId*string

Your own id for the player.

amount*integer

How much to move the balance by. Positive credits, negative debits; zero is rejected.

Formatint64

reason?|

A free-text note explaining the adjustment.

idempotencyKey?|

An optional client key that makes a retried adjustment return the original instead of moving the balance twice.

Response Body

`application/json`

curl -X POST "https://example.com/v1/points/adjustments" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string",    "amount": 0  }'

{  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",  "amount": 0,  "balance": 0}

Adjust a points balance

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

404application/json

409application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`