API ReferenceWooCommerceSDKssoonWebhookssoon

Claims

View a cashback claim

GET/api/v2/claim/:token

What the claim page renders before the customer names a wallet: how much is waiting, who it is from, and when the offer lapses. Powers the page behind an emailed claim link.

  • No authentication: the one-time token IS the authorisation. Never log it, never put it in a URL you send onward.
  • Rate limited to 30 requests per 15 minutes per IP, so tokens cannot be brute-forced.
  • 404 { success: false, error: "This claim link is not valid or has expired." } covers a bad token, a spent token, and a lapsed one alike — deliberately indistinguishable, so a guesser learns nothing.
  • Reading a claim moves nothing. The link carries no funds; it is an invitation to be paid from the merchant's wallet.

Authentication

No authentication required.

Path parameters

tokenstringrequired

the one-time token from the claim link

GET/api/v2/claim/:token
curl "https://api.trevi.cash/api/v2/claim/CLAIM_TOKEN"
200Sample response
{
  "success": true,
  "claim": {
    "amount_sats": 4500,
    "merchant_name": "Bel Tempo",
    "expires_at": "2026-09-12T12:04:11.000Z"
  }
}