POST `/admin/points/{user_id}/expire`

Admin operation. Manually trigger points expiration, deducting the specified points from available balance and marking them as expired. If the requested amount exceeds the current available balance, it is settled proportionally. Idempotent via X-Idempotency-Key header.

Points Service `bearerAuth` application/json

Request Parameters

Name	In	Type	Required	Default	Example	Constraints	Description
`user_id`	`path`	`string`	Yes				User ID
`X-Idempotency-Key`	`header`	`string`	No				Idempotency key, UUID recommended

Request Body

Schema: dto.ExpirePointsRequest

Field	Type	Required	Example	Constraints	Description
`amount`	`integer`	Yes
`description`	`string`	No

Responses

Status	Description	Schema
200	Points expiration processed	`dto.PointOperationResponse`
400	Bad request	`gitee_com_linmes_authms_base_dto.SimpleResponse`
401	Unauthorized	`gitee_com_linmes_authms_base_dto.SimpleResponse`
403	Forbidden	`gitee_com_linmes_authms_base_dto.SimpleResponse`
404	Account not found	`gitee_com_linmes_authms_base_dto.SimpleResponse`
500	Internal server error	`gitee_com_linmes_authms_base_dto.SimpleResponse`

Referenced Schemas

dto.PointAccountResponse

Field	Type	Required	Example
`balance`	`integer`	No	`1500`
`created_at`	`string`	No	`2026-01-15T10:30:00Z`
`exchange_rate`	`integer`	No	`100`
`expired_points`	`integer`	No	`100`
`frozen_balance`	`integer`	No	`200`
`id`	`string`	No	`01ARZ3NDEKTSV4RRFFQ69G5FAV`
`points_type`	`string`	No	`cash_equivalent`
`status`	`string`	No	`active`
`tenant_id`	`string`	No	`tnt_example_001`
`total_earned`	`integer`	No	`5000`
`total_spent`	`integer`	No	`3500`
`updated_at`	`string`	No	`2026-04-10T14:20:00Z`
`user_id`	`string`	No	`usr_example_001`
`version`	`integer`	No	`3`

dto.PointOperationData

Field	Type	Required	Example
`account`	`dto.PointAccountResponse`	No
`points_earned`	`integer`	No	`100`
`transaction`	`dto.PointTransactionResponse`	No

dto.PointOperationResponse

Field	Type	Required
`code`	`integer`	No
`data`	`dto.PointOperationData`	No
`message`	`string`	No
`timestamp`	`string`	No

dto.PointTransactionResponse

Field	Type	Required	Example
`account_id`	`string`	No	`01ARZ3NDEKTSV4RRFFQ69G5FAV`
`amount`	`integer`	No	`100`
`balance_after`	`integer`	No	`1500`
`balance_before`	`integer`	No	`1400`
`created_at`	`string`	No	`2026-04-15T10:30:00Z`
`description`	`string`	No	`Daily check-in reward`
`expires_at`	`string`	No	`2027-01-15T10:30:00Z`
`id`	`string`	No	`01ARZ3NDEKTSV4RRFFQ69G5FAV`
`idempotency_key`	`string`	No	`ik_abc123`
`reason`	`string`	No	`Check-in reward`
`related_id`	`string`	No	`01ARZ3NDEKTSV4RRFFQ69G5FAV`
`source`	`string`	No	`daily_checkin`
`status`	`string`	No	`completed`
`type`	`string`	No	`earn`
`updated_at`	`string`	No	`2026-04-15T10:30:00Z`
`user_id`	`string`	No	`usr_example_001`

gitee_com_linmes_authms_base_dto.SimpleResponse

Field	Type	Required
`code`	`integer`	No
`message`	`string`	No
`timestamp`	`string`	No

Try this API in Scalar → Download OpenAPI spec (JSON) ↓

POST /admin/points/{user_id}/expire