Use this gift card online or in store.
" }, "fulfillment": { "delivery_method": "claim_link", "asset_scale": 0, "countries": ["US"], "currencies": ["USD"], "value_min_minor": 500, "value_max_minor": 10000, "denominations_minor": [], "rate": "0.01" } } ] } ``` Keep the reward's `id` for the redemption request. Follow `pagination.next_cursor` if the catalog has more pages. When rendering content from `display`, handle missing fields and sanitize HTML. An active reward can still be unavailable to a particular participant, for example because they have too little balance or have reached a redemption limit. Scrip checks those conditions when they redeem. ## Choose a value and show the price The card's face value is the amount the participant can spend with the merchant. The API expresses it in currency minor units, such as cents for USD. A USD 100.00 card has a `face_value_minor` of `10000`. For an `AMOUNT_BASED` gift card, let the participant choose a supported value and a currency from `fulfillment.currencies`. A product can offer a list of values in `denominations_minor`, an inclusive minimum-to-maximum range, or both. A value is valid if it appears in the list or falls within the range. Multiply the chosen face value by `fulfillment.rate` to show the asset price. In this example, `10000 × 0.01 = 100` stars. Round up to the decimal precision in `fulfillment.asset_scale` using decimal arithmetic. See [Pricing](/guides/reward-sources#pricing) to set the rate and [Price fractional assets](/guides/reward-sources#price-fractional-assets) for rounding examples. For a `UNIT_BASED` gift card, you have already chosen a fixed value and currency during setup. Show that value and use `unit_cost` as the asset price. The participant does not need to choose a value. ## Redeem When the participant confirms their choice, submit the reward ID and card value: ```bash theme={null} POST /v1/participants/{id}/redemptions/items ``` ```json theme={null} { "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01", "reward_id": "2b7a9c4e-1f3d-4a8b-9e6c-5a1d3f7b8c02", "idempotency_key": "gift-card-order-4471", "expected_amount": "100", "fulfillment": { "face_value_minor": 10000, "currency": "USD" } } ``` Scrip calculates the asset charge from the reward's price. Send the card value in `fulfillment`; omit the custom-reward `amount` field. Each redemption orders one card, so omit `quantity` or set it to `1`. Send the price the participant reviewed as `expected_amount`, in asset units. If the current cost differs, Scrip returns `409 reward_price_changed` without creating an order or reserving assets. Fetch the catalog again and ask the participant to confirm the updated price. This field is optional, but recommended whenever you show a price before redeeming. For fixed-value cards, also send the value and currency the participant reviewed. Scrip rejects the request if either has changed. You can omit them with `fulfillment: {}` when you want to use the card's current settings without this check. Use a unique `idempotency_key` for each purchase. If a request times out, retry the same request with the same key to retrieve the existing redemption. Its original charge is preserved even if the catalog price changes later. Scrip first reserves the cost in the participant's `HELD` balance, then orders the card. Once the order succeeds, it captures that balance to the program's redemption target (`SYSTEM_REDEMPTION` by default). If fulfillment fails, it releases the remaining reserved balance. Scrip handles completion automatically; omit `capture` from the request. The request waits up to about 30 seconds for the result. A successful response can include the claim link immediately. Relevant fields are shown below: ```json theme={null} { "id": "7f422b43-4ba2-41c7-b05d-e4e90b68e978", "status": "COMPLETED", "amount": "100", "fulfillment": { "status": "SUCCEEDED", "claim_url": "https://claim.example.com/abc123" } } ``` Read the redemption's `status` to decide what to show: | Status | What to do | | ----------- | ----------------------------------------------------------------------------------------- | | `COMPLETED` | Show the claim link. If the response has no link, retrieve it with the endpoint below. | | `PENDING` | Show that the card is being prepared. Keep the redemption ID and wait for the outcome. | | `FAILED` | Show that the card could not be ordered. Use `fulfillment.failure_reason` to investigate. | A new redemption returns HTTP `201`, including when it is still pending. A retry with the same idempotency key returns the existing redemption with `200`. ## Deliver the claim link A claim link opens the page where the participant accesses their gift card. Show `fulfillment.claim_url` from the redemption response when it is present. To retrieve a link after the order finishes, or when the participant returns later, use the same redemption ID: ```bash theme={null} POST /v1/redemptions/{id}/claim-link ``` Send no request body. The response includes the URL: ```json theme={null} { "claim_url": "https://claim.example.com/abc123", "status": "SUCCEEDED", "expires_at": "2026-12-01T10:30:00Z" } ``` `expires_at` appears only when a link expiry is available. The endpoint can return the same URL on later requests. Reading a redemption or receiving a webhook does not return a claim link. A missing link does not mean the purchase failed. Retrieve it for the existing redemption so the participant is not charged for another card. See [Create a claim link](/api-reference/redemptions/create-a-claim-link) for error handling. ## Handle a pending order Subscribe to `redemption.fulfillment_succeeded` and `redemption.fulfillment_failed` to receive the outcome. On success, retrieve the claim link for that redemption. You can also check its status with `GET /v1/redemptions/{id}`. To return immediately when creating a redemption, send the `Prefer: respond-async` header. If `fulfillment.status` is `AWAITING_FUNDS`, add funds to your fulfillment account in the dashboard. Scrip retries the order automatically and sends `fulfillment_account.funds_low` once for that fulfillment. The participant's reserved balance stays held while the order waits. If the funding window expires, the order fails and the remaining reserved balance is released. The default window is 24 hours; the redemption's reservation deadline can end the wait sooner. Scrip controls the order's completion. Cancellation is available only before an order is placed, and a delivered gift card cannot be reversed through Scrip. See [Get redemption](/api-reference/redemptions/get-redemption#gift-card-fulfillment) for status and failure details, and [Redemption lifecycle](/guides/redemption-lifecycle) for reservation deadlines and ledger entries. ## Set redemption limits You can limit each card's value and how many cards a participant redeems over a rolling period. For example, allow cards worth up to USD 100.00 each, with at most three cards totaling USD 250.00 per participant over 24 hours. Configure these limits on the program; Scrip checks them before reserving any balance. See [Update a program](/api-reference/programs/update-a-program#gift-card-limits) for the fields and validation rules. To stop new gift-card redemptions for an account, disable it in the dashboard.