Sign in
Transfers

Claim

Changed on

Claims a funded link into the authenticated user's personal balance and returns the updated link. Requires a signed-in user and the public claim code; account API keys cannot claim on a recipient's behalf. Each user can claim a link once. Reuse the same Idempotency-Key when retrying the same request. On-chain claims may take several minutes to complete.

post/claim_links/{id}/claim

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/claim_links/{id}/claim
  • Auth: HTTP bearer

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Response

claim link claimed

amountstring required

Amount each claim receives.

claim_urlstring nullable required

Shareable claim URL. Null when retrieving by ID without claim-link management access.

claimableboolean required

Whether this link can currently be claimed.

codestring nullable required

Redeemable claim code. Null when retrieving by ID without claim-link management access.

created_atstring date-time required
currencystring required
expires_atstring date-time nullable required
idstring required

Claim-link ID, prefixed airdrp_.

object'claim_link' required
redeemable_countinteger required

Maximum number of claims.

redeemed_countinteger required

Number of completed claims.

remaining_claimsinteger required

Number of available claims, excluding slots reserved by pending claims.

status'pending' | 'fully_claimed' | 'canceled' | 'expired' required

The link's lifecycle status. A newly funded link is pending. Check claimable for current availability, including expiry and reserved claims.

Example response

{
  "amount": "25.00",
  "claim_url": "https://whop.com/claim",
  "code": "demoClaim123",
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "id": "airdrp_xxxxxxxxxxxxxx",
  "object": "claim_link",
  "redeemable_count": 1,
  "redeemed_count": 1,
  "sender": {
    "id": "biz_xxxxxxxxxxxxxx",
    "object": "account",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "source": {
    "account_id": "biz_xxxxxxxxxxxxxx"
  },
  "status": "fully_claimed"
}

Changes