Skip to main content
POST
Deduct points

Authorizations

Authorization
string
header
required

API key from the Rigaly dashboard: Authorization: Bearer rgly_sk_...

Headers

Idempotency-Key
string

Optional. Retries with the same key within 24h replay the original response instead of repeating the operation.

Maximum string length: 255

Body

application/json

Exactly one of user_id / identifier is required.

points
integer
required
Required range: 1 <= x <= 1000000
user_id
string<uuid>

Rigaly customer ID

identifier
string

Email, phone, or a business-scoped external identifier

description
string

Shown in the customer's transaction history

Maximum string length: 500

Response

Points deducted

success
boolean
Example:

true

message
string
data
object