Nippy API Platform

claim() completes delivery for prizes that are not credited automatically.

Usage

const result = await nippy.claim({
  spinId: 'spin-abc',
  userId: 'user-123'
})

curl -X POST https://ms.nippy.la/v1/public/claims \
  -H "x-api-key: npk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "spinId": "spin-abc",
    "userId": "user-123"
  }'

Parameters

string

required

ID of the spin that generated the prize. Example: spin-abc.

string

required

Must match the userId from the original spin. Example: user-123.

Response

string

Unique claim ID.

string

Claim status. Expected value: claimed.

object

Claimed prize.

string

Claimed prize ID.

string

Claimed prize name.

string

Prize type. Examples: won_digital, won_physical.

number | null

Points associated with the prize, if applicable.

string

ISO 8601 timestamp when the claim was completed.

Reservations have an expiration date. If the user does not claim before prizeReservation.expiresAt, the prize is released back to inventory.

Start here

SDK

MCP

claim()

Usage

Parameters

Response

​Usage

​Parameters

​Response

Usage

Parameters

Response