Skip to main content
POST
Create a custom redemption

Authorizations

Api-Key
string
header
required

Headers

idempotency-key
string
required

Required retry key for this redemption. Reusing the same key and body replays the cached 201 response. Maximum 64 characters.

Required string length: 1 - 64

Body

application/json

Custom redemption request

userId
string<uuid>
required

The ID of the user redeeming points

raindropAmount
string
required

The number of points to redeem, as a string (must be a positive integer)

Pattern: ^[1-9][0-9]*$
reason
string
required

The reason for the redemption, recorded with the redemption

Required string length: 1 - 255

Response

Custom redemption created successfully

redemptionId
string<uuid>

The ID of the created redemption

redemptionType
enum<string>

The type of redemption

Available options:
CUSTOM
raindropAmount
string

The number of points redeemed, as a string

status
enum<string>

The current status of the redemption. PARTNER_OFFCHAIN redemptions are recorded as COMPLETED; RAIN_MANAGED redemptions return PENDING and settle on-chain.

Available options:
PENDING,
COMPLETED