Redemptions

Create a claim link

Create a claim link for a successfully fulfilled redemption.

post/v1/redemptions/{redemption_id}/claim-link

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/redemptions/{redemption_id}/claim-link
Auth: HTTP bearer

Path parameters

redemption_idstring uuid required

The redemption's id.

Headers

Idempotency-Keystring

A key you choose to make this request safe to retry: 1 to 255 printable ASCII characters. Send the same key with the same request to get the first response again, marked Idempotent-Replayed: true. Routes that return a secret once, and claim links, do not replay a response. Event ingest uses the key as the event's identity.

Response

Usable claim link

claim_urlstring

URL the participant can use to access the fulfilled reward

expires_atstring date-time

Link expiry, present only when the provider reports one

providerstring

The gift-card provider that issued the claim link.

status'SUCCEEDED'

Fulfillment lifecycle status (always SUCCEEDED on a 200 response)

Example response

{
  "claim_url": "https://claim.example.com/abc123",
  "expires_at": "2027-12-31T23:59:59Z",
  "provider": "TREMENDOUS",
  "status": "SUCCEEDED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.