POST /v1/cash/grants
Service: cash · operationId: (none)
Grant promotional cash to a user account (admin only)
Required scopes
(no scope declared — review service config)
Required headers
idempotency-key—
Request body
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"description": "Target user ID"
},
"brand_id": {
"type": "string",
"minLength": 1,
"description": "Brand scope"
},
"amount_cents": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Amount in cents to grant"
},
"source": {
"type": "string",
"minLength": 1,
"description": "Grant source (e.g. promotion, referral)"
},
"reason": {
"type": "string",
"description": "Human-readable reason"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Optional expiry timestamp"
},
"memo": {
"type": "string",
"description": "Optional memo"
}
},
"required": [
"user_id",
"brand_id",
"amount_cents",
"source"
]
}Responses
201 Cash granted successfully
{
"type": "object",
"properties": {
"grant_id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"amount_cents": {
"type": "integer"
},
"balance_cents": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"grant_id",
"account_id",
"amount_cents",
"balance_cents",
"created_at"
]
}400 Validation error
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}500 Internal server error
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}Example
curl -X POST https://cash.platform.loop.health/v1/cash/grants \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'Related
services/cash— service overview- All endpoints — directory across services
- Auth model — how scopes are enforced