Redeem a catalog item

curl --request POST \
  --url https://api.scrip.dev/v1/participants/{id}/redemptions/items \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "program_id": "550e8400-e29b-41d4-a716-446655440000",
  "reward_id": "550e8400-e29b-41d4-a716-446655440001",
  "amount": "50.00",
  "capture": false,
  "description": "Gift card redemption",
  "expires_at": "2024-01-15T11:30:00Z",
  "idempotency_key": "redeem-item-12345",
  "quantity": 2,
  "ttl_seconds": 3600
}
'

import requests

url = "https://api.scrip.dev/v1/participants/{id}/redemptions/items"

payload = {
    "program_id": "550e8400-e29b-41d4-a716-446655440000",
    "reward_id": "550e8400-e29b-41d4-a716-446655440001",
    "amount": "50.00",
    "capture": False,
    "description": "Gift card redemption",
    "expires_at": "2024-01-15T11:30:00Z",
    "idempotency_key": "redeem-item-12345",
    "quantity": 2,
    "ttl_seconds": 3600
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    program_id: '550e8400-e29b-41d4-a716-446655440000',
    reward_id: '550e8400-e29b-41d4-a716-446655440001',
    amount: '50.00',
    capture: false,
    description: 'Gift card redemption',
    expires_at: '2024-01-15T11:30:00Z',
    idempotency_key: 'redeem-item-12345',
    quantity: 2,
    ttl_seconds: 3600
  })
};

fetch('https://api.scrip.dev/v1/participants/{id}/redemptions/items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrip.dev/v1/participants/{id}/redemptions/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'program_id' => '550e8400-e29b-41d4-a716-446655440000',
    'reward_id' => '550e8400-e29b-41d4-a716-446655440001',
    'amount' => '50.00',
    'capture' => false,
    'description' => 'Gift card redemption',
    'expires_at' => '2024-01-15T11:30:00Z',
    'idempotency_key' => 'redeem-item-12345',
    'quantity' => 2,
    'ttl_seconds' => 3600
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrip.dev/v1/participants/{id}/redemptions/items"

	payload := strings.NewReader("{\n  \"program_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"reward_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"amount\": \"50.00\",\n  \"capture\": false,\n  \"description\": \"Gift card redemption\",\n  \"expires_at\": \"2024-01-15T11:30:00Z\",\n  \"idempotency_key\": \"redeem-item-12345\",\n  \"quantity\": 2,\n  \"ttl_seconds\": 3600\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scrip.dev/v1/participants/{id}/redemptions/items")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"program_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"reward_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"amount\": \"50.00\",\n  \"capture\": false,\n  \"description\": \"Gift card redemption\",\n  \"expires_at\": \"2024-01-15T11:30:00Z\",\n  \"idempotency_key\": \"redeem-item-12345\",\n  \"quantity\": 2,\n  \"ttl_seconds\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/participants/{id}/redemptions/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"program_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"reward_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"amount\": \"50.00\",\n  \"capture\": false,\n  \"description\": \"Gift card redemption\",\n  \"expires_at\": \"2024-01-15T11:30:00Z\",\n  \"idempotency_key\": \"redeem-item-12345\",\n  \"quantity\": 2,\n  \"ttl_seconds\": 3600\n}"

response = http.request(request)
puts response.read_body

{
  "amount": "1000.00",
  "asset_id": "550e8400-e29b-41d4-a716-446655440003",
  "capture_journal_entry_id": "550e8400-e29b-41d4-a716-446655440007",
  "captured_at": "2024-01-15T10:45:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Redeemed: Gift Card",
  "expires_at": "2024-01-15T11:30:00Z",
  "failure_reason": "fulfillment_failed",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "journal_entry_id": "550e8400-e29b-41d4-a716-446655440005",
  "participant_id": "550e8400-e29b-41d4-a716-446655440002",
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "quantity": 2,
  "reservation_id": "550e8400-e29b-41d4-a716-446655440006",
  "resolved_at": "2024-01-15T10:45:00Z",
  "reversed_amount": "0.00",
  "reversed_quantity": 0,
  "reward_id": "550e8400-e29b-41d4-a716-446655440004",
  "status": "COMPLETED",
  "unit_cost": "500.00",
  "updated_at": "2024-01-15T10:30:00Z"
}

{
  "amount": "1000.00",
  "asset_id": "550e8400-e29b-41d4-a716-446655440003",
  "capture_journal_entry_id": "550e8400-e29b-41d4-a716-446655440007",
  "captured_at": "2024-01-15T10:45:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Redeemed: Gift Card",
  "expires_at": "2024-01-15T11:30:00Z",
  "failure_reason": "fulfillment_failed",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "journal_entry_id": "550e8400-e29b-41d4-a716-446655440005",
  "participant_id": "550e8400-e29b-41d4-a716-446655440002",
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "quantity": 2,
  "reservation_id": "550e8400-e29b-41d4-a716-446655440006",
  "resolved_at": "2024-01-15T10:45:00Z",
  "reversed_amount": "0.00",
  "reversed_quantity": 0,
  "reward_id": "550e8400-e29b-41d4-a716-446655440004",
  "status": "COMPLETED",
  "unit_cost": "500.00",
  "updated_at": "2024-01-15T10:30:00Z"
}

{
  "code": "bad_request",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Invalid request parameters"
}

{
  "code": "unauthorized",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Missing or invalid credentials"
}

{
  "code": "not_found",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource not found"
}

{
  "code": "conflict",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource already exists or state conflict"
}

{
  "code": "unsupported_media_type",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Content-Type must be application/json"
}

{
  "code": "unprocessable",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Business rule violation"
}

{
  "code": "internal_error",
  "message": "An internal error occurred"
}

POST

participants

{id}

redemptions

items

Redeem a catalog item

curl --request POST \
  --url https://api.scrip.dev/v1/participants/{id}/redemptions/items \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "program_id": "550e8400-e29b-41d4-a716-446655440000",
  "reward_id": "550e8400-e29b-41d4-a716-446655440001",
  "amount": "50.00",
  "capture": false,
  "description": "Gift card redemption",
  "expires_at": "2024-01-15T11:30:00Z",
  "idempotency_key": "redeem-item-12345",
  "quantity": 2,
  "ttl_seconds": 3600
}
'

import requests

url = "https://api.scrip.dev/v1/participants/{id}/redemptions/items"

payload = {
    "program_id": "550e8400-e29b-41d4-a716-446655440000",
    "reward_id": "550e8400-e29b-41d4-a716-446655440001",
    "amount": "50.00",
    "capture": False,
    "description": "Gift card redemption",
    "expires_at": "2024-01-15T11:30:00Z",
    "idempotency_key": "redeem-item-12345",
    "quantity": 2,
    "ttl_seconds": 3600
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    program_id: '550e8400-e29b-41d4-a716-446655440000',
    reward_id: '550e8400-e29b-41d4-a716-446655440001',
    amount: '50.00',
    capture: false,
    description: 'Gift card redemption',
    expires_at: '2024-01-15T11:30:00Z',
    idempotency_key: 'redeem-item-12345',
    quantity: 2,
    ttl_seconds: 3600
  })
};

fetch('https://api.scrip.dev/v1/participants/{id}/redemptions/items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrip.dev/v1/participants/{id}/redemptions/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'program_id' => '550e8400-e29b-41d4-a716-446655440000',
    'reward_id' => '550e8400-e29b-41d4-a716-446655440001',
    'amount' => '50.00',
    'capture' => false,
    'description' => 'Gift card redemption',
    'expires_at' => '2024-01-15T11:30:00Z',
    'idempotency_key' => 'redeem-item-12345',
    'quantity' => 2,
    'ttl_seconds' => 3600
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrip.dev/v1/participants/{id}/redemptions/items"

	payload := strings.NewReader("{\n  \"program_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"reward_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"amount\": \"50.00\",\n  \"capture\": false,\n  \"description\": \"Gift card redemption\",\n  \"expires_at\": \"2024-01-15T11:30:00Z\",\n  \"idempotency_key\": \"redeem-item-12345\",\n  \"quantity\": 2,\n  \"ttl_seconds\": 3600\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scrip.dev/v1/participants/{id}/redemptions/items")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"program_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"reward_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"amount\": \"50.00\",\n  \"capture\": false,\n  \"description\": \"Gift card redemption\",\n  \"expires_at\": \"2024-01-15T11:30:00Z\",\n  \"idempotency_key\": \"redeem-item-12345\",\n  \"quantity\": 2,\n  \"ttl_seconds\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/participants/{id}/redemptions/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"program_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"reward_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"amount\": \"50.00\",\n  \"capture\": false,\n  \"description\": \"Gift card redemption\",\n  \"expires_at\": \"2024-01-15T11:30:00Z\",\n  \"idempotency_key\": \"redeem-item-12345\",\n  \"quantity\": 2,\n  \"ttl_seconds\": 3600\n}"

response = http.request(request)
puts response.read_body

{
  "amount": "1000.00",
  "asset_id": "550e8400-e29b-41d4-a716-446655440003",
  "capture_journal_entry_id": "550e8400-e29b-41d4-a716-446655440007",
  "captured_at": "2024-01-15T10:45:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Redeemed: Gift Card",
  "expires_at": "2024-01-15T11:30:00Z",
  "failure_reason": "fulfillment_failed",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "journal_entry_id": "550e8400-e29b-41d4-a716-446655440005",
  "participant_id": "550e8400-e29b-41d4-a716-446655440002",
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "quantity": 2,
  "reservation_id": "550e8400-e29b-41d4-a716-446655440006",
  "resolved_at": "2024-01-15T10:45:00Z",
  "reversed_amount": "0.00",
  "reversed_quantity": 0,
  "reward_id": "550e8400-e29b-41d4-a716-446655440004",
  "status": "COMPLETED",
  "unit_cost": "500.00",
  "updated_at": "2024-01-15T10:30:00Z"
}

{
  "amount": "1000.00",
  "asset_id": "550e8400-e29b-41d4-a716-446655440003",
  "capture_journal_entry_id": "550e8400-e29b-41d4-a716-446655440007",
  "captured_at": "2024-01-15T10:45:00Z",
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Redeemed: Gift Card",
  "expires_at": "2024-01-15T11:30:00Z",
  "failure_reason": "fulfillment_failed",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "journal_entry_id": "550e8400-e29b-41d4-a716-446655440005",
  "participant_id": "550e8400-e29b-41d4-a716-446655440002",
  "program_id": "550e8400-e29b-41d4-a716-446655440001",
  "quantity": 2,
  "reservation_id": "550e8400-e29b-41d4-a716-446655440006",
  "resolved_at": "2024-01-15T10:45:00Z",
  "reversed_amount": "0.00",
  "reversed_quantity": 0,
  "reward_id": "550e8400-e29b-41d4-a716-446655440004",
  "status": "COMPLETED",
  "unit_cost": "500.00",
  "updated_at": "2024-01-15T10:30:00Z"
}

{
  "code": "bad_request",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Invalid request parameters"
}

{
  "code": "unauthorized",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Missing or invalid credentials"
}

{
  "code": "not_found",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource not found"
}

{
  "code": "conflict",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource already exists or state conflict"
}

{
  "code": "unsupported_media_type",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Content-Type must be application/json"
}

{
  "code": "unprocessable",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Business rule violation"
}

{
  "code": "internal_error",
  "message": "An internal error occurred"
}

Creates a redemption for a reward in the program catalog. For UNIT_BASED rewards, specify quantity (defaults to 1); for AMOUNT_BASED rewards, specify amount. Set capture: true to capture immediately, capture: false to authorize into PENDING, or omit it to use the program’s fulfillment_mode. Instant capture debits AVAILABLE and credits the redemption target. Authorization moves the calculated cost to HELD and returns reservation_id plus the effective expires_at. Use expires_at or ttl_seconds to bound a pending redemption; they are mutually exclusive. For UNIT_BASED rewards, both paths commit catalog inventory immediately, so committed_units includes units still awaiting fulfillment. Pass an idempotency_key to safely retry requests. Duplicate requests return 200 with the existing redemption instead of 201.

For deadline selection and resolution endpoints, see the Redemption lifecycle guide. For committed, pending, and delivered inventory, see Rewards Catalog.

Authorizations

X-API-Key

string

header

required

API key passed in the X-API-Key header.

Path Parameters

string<uuid>

required

Participant ID

Body

application/json

Catalog item redemption details

program_id

string<uuid>

required

The program this redemption belongs to

Example:

"550e8400-e29b-41d4-a716-446655440000"

reward_id

string<uuid>

required

The reward catalog item to redeem

Example:

"550e8400-e29b-41d4-a716-446655440001"

amount

string

Amount to redeem (AMOUNT_BASED rewards only, decimal string)

Example:

"50.00"

capture

boolean

Whether to capture immediately. True completes instantly, false authorizes, and omission uses the program fulfillment_mode.

Example:

false

description

string

Optional context for this redemption, used in journal entries (max 500 chars)

Example:

"Gift card redemption"

expires_at

string<date-time>

Absolute pending-redemption deadline (RFC3339); alternative to ttl_seconds and limited to one year. If no request or program deadline is set, the authorization defaults to 90 days.

Example:

"2024-01-15T11:30:00Z"

idempotency_key

string

Prevents duplicate redemptions when retrying requests

Example:

"redeem-item-12345"

quantity

integer

Number of units to redeem (UNIT_BASED rewards only, defaults to 1)

Example:

2

ttl_seconds

integer

Relative pending-redemption deadline in seconds; alternative to expires_at and limited to one year. If no request or program deadline is set, the authorization defaults to 90 days.

Example:

3600

Response

Duplicate request (idempotency key matched, returns existing record)

amount

string

Total amount debited from the participant's balance (decimal string)

Example:

"1000.00"

asset_id

string<uuid>

The asset that was debited

Example:

"550e8400-e29b-41d4-a716-446655440003"

capture_journal_entry_id

string<uuid>

Ledger entry that captured a pending redemption

Example:

"550e8400-e29b-41d4-a716-446655440007"

captured_at

string<date-time>

When the pending redemption was captured

Example:

"2024-01-15T10:45:00Z"

created_at

string<date-time>

When this redemption was created

Example:

"2024-01-15T10:30:00Z"

description

string

Context for this redemption, used in journal entries

Example:

"Redeemed: Gift Card"

expires_at

string<date-time>

Effective deadline of the backing reservation. Always present for pending redemptions; defaults to 90 days and may be configured up to one year.

Example:

"2024-01-15T11:30:00Z"

failure_reason

string

Machine-readable or operator-supplied terminal failure detail

Example:

"fulfillment_failed"

string<uuid>

Unique identifier for this redemption

Example:

"550e8400-e29b-41d4-a716-446655440000"

journal_entry_id

string<uuid>

Immutable ledger anchor: the hold entry for pending redemptions, otherwise the instant redemption entry

Example:

"550e8400-e29b-41d4-a716-446655440005"

participant_id

string<uuid>

The participant who redeemed

Example:

"550e8400-e29b-41d4-a716-446655440002"

program_id

string<uuid>

The program this redemption belongs to

Example:

"550e8400-e29b-41d4-a716-446655440001"

quantity

integer

Number of units redeemed (catalog redemptions only)

Example:

2

reservation_id

string<uuid>

Reservation backing a pending redemption

Example:

"550e8400-e29b-41d4-a716-446655440006"

resolved_at

string<date-time>

When the pending redemption reached a terminal state

Example:

"2024-01-15T10:45:00Z"

reversed_amount

string

Cumulative amount reversed so far (decimal string)

Example:

"0.00"

reversed_quantity

integer

Cumulative units reversed so far (UNIT_BASED catalog redemptions only)

Example:

0

reward_id

string<uuid>

The reward catalog item that was redeemed (catalog redemptions only)

Example:

"550e8400-e29b-41d4-a716-446655440004"

status

enum<string>

Current lifecycle and reversal state

Available options:

PENDING,

COMPLETED,

FAILED,

CANCELLED,

PARTIALLY_REVERSED,

FULLY_REVERSED

Example:

"COMPLETED"

unit_cost

string

Cost per unit at the time of redemption (catalog redemptions only, decimal string)

Example:

"500.00"

updated_at

string<date-time>

When this redemption was last updated (e.g., after a reversal)

Example:

"2024-01-15T10:30:00Z"

Scrip API

Endpoints

Redeem a catalog item

Authorizations

Path Parameters

Body

Response