Skip to main content
POST
Redeem points for statement credit

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

Statement credit 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]*$

Response

Statement credit redemption created successfully

redemptionId
string<uuid>

The ID of the created redemption

userId
string<uuid>

The ID of the user who redeemed

type
enum<string>

The type of redemption

Available options:
STATEMENT_CREDIT
raindropAmount
string

The number of points redeemed, as a string