---
title: "Create a claim link"
method: POST
path: "/v1/redemptions/{redemption_id}/claim-link"
tags: ["Redemptions"]
---

# Create a claim link

`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

Create a claim link for a successfully fulfilled redemption.

## Path parameters

- `redemption_id` string, uuid, required

## Headers

- `Idempotency-Key` string

## Response `201`

Usable claim link

- ClaimLinkResponse: A gift-card claim link for a fulfilled redemption, and when it expires.
  - `claim_url` string: URL the participant can use to access the fulfilled reward
  - `expires_at` string, date-time: Link expiry, present only when the provider reports one
  - `provider` string: The gift-card provider that issued the claim link.
  - `status` 'SUCCEEDED': Fulfillment lifecycle status (always SUCCEEDED on a 200 response)

## Other responses

- `400`: Invalid ID format (code: validation_error)
- `401`: The API key is missing or not valid. See [Authentication](https://docs.scrip.dev/authentication).
- `403`: The caller is not allowed to do this.
- `404`: Redemption not found (code: redemption_not_found)
- `409`: The fulfillment has not yet succeeded; retry shortly (code: claim_link_not_ready)
- `422`: The redemption has no gift-card fulfillment, its fulfillment failed terminally, or the provider does not support claim-link delivery (code: claim_link_not_applicable | claim_link_fulfillment_failed | claim_link_unsupported)
- `429`: Too many requests. Wait the number of seconds in the `Retry-After` header, then retry. See [Limits and durations](https://docs.scrip.dev/limits#rate-limits).
- `500`: Something failed on Scrip's side. Retry the request, and quote `request_id` if it keeps failing. [Errors](https://docs.scrip.dev/errors) lists every code, and the [API introduction](https://docs.scrip.dev/api-reference/introduction) describes the error format.
- `502`: The vendor rejected or failed the claim-link request (code: claim_link_provider_error)
- `503`: Claim-link creation is unavailable; retry provider_unavailable, or contact support for provider_connections_not_configured (code: provider_connections_not_configured | provider_unavailable)

---

[API](https://skmtc.dev/scrip/apis/scrip-api.md) · [All operations](https://skmtc.dev/scrip/apis/scrip-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrip/apis/scrip-api/revisions/c52d35da8d97?raw)