List participant redemptions
curl --request GET \
--url https://api.scrip.dev/v1/participants/{id}/redemptions \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.scrip.dev/v1/participants/{id}/redemptions"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/participants/{id}/redemptions', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/participants/{id}/redemptions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/participants/{id}/redemptions")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/participants/{id}/redemptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"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",
"fulfillment": {
"claim_url": "https://claim.example.com/abc123",
"created_at": "2024-01-15T10:30:00Z",
"face_currency": "USD",
"face_value_minor": 2500,
"failure_reason": "provider_permanent_error",
"provider": "TREMENDOUS",
"provider_order_id": "ord_abc123",
"resolved_at": "2024-01-15T10:45:00Z",
"status": "PROCESSING",
"updated_at": "2024-01-15T10:30:00Z"
},
"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,
"release_journal_entry_id": "550e8400-e29b-41d4-a716-446655440008",
"released_amount": "1000.00",
"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"
}
],
"pagination": {
"has_more": true,
"next_cursor": "YWJjMTIz"
}
}{
"code": "bad_request",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Missing or invalid credentials"
}{
"code": "internal_error",
"message": "An internal error occurred"
}Redemptions
List participant redemptions
List redemptions for a participant. The from and to filters use redemption creation (authorization) time, including for redemptions captured later.
GET
/
v1
/
participants
/
{id}
/
redemptions
List participant redemptions
curl --request GET \
--url https://api.scrip.dev/v1/participants/{id}/redemptions \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.scrip.dev/v1/participants/{id}/redemptions"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/participants/{id}/redemptions', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/participants/{id}/redemptions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/participants/{id}/redemptions")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/participants/{id}/redemptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"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",
"fulfillment": {
"claim_url": "https://claim.example.com/abc123",
"created_at": "2024-01-15T10:30:00Z",
"face_currency": "USD",
"face_value_minor": 2500,
"failure_reason": "provider_permanent_error",
"provider": "TREMENDOUS",
"provider_order_id": "ord_abc123",
"resolved_at": "2024-01-15T10:45:00Z",
"status": "PROCESSING",
"updated_at": "2024-01-15T10:30:00Z"
},
"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,
"release_journal_entry_id": "550e8400-e29b-41d4-a716-446655440008",
"released_amount": "1000.00",
"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"
}
],
"pagination": {
"has_more": true,
"next_cursor": "YWJjMTIz"
}
}{
"code": "bad_request",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Missing or invalid credentials"
}{
"code": "internal_error",
"message": "An internal error occurred"
}Lists all redemptions for a participant, including amount and catalog redemptions. Filter by any lifecycle status or
reward_catalog_item_id. Results are ordered by creation time, most recent first.
Each entry has the same fields as Get redemption: the redemption ID, asset, amount, status, and the reward_id and quantity for catalog redemptions. It also includes the journal entry IDs: journal_entry_id, capture_journal_entry_id, and, when reserved value was released, release_journal_entry_id with released_amount.
from and to filter on creation time. For a pending redemption, this is authorization time. A redemption authorized in June and captured in July appears in a June-filtered list, while reporting recognizes it in July.
For the distinction between authorization and recognition time, see the Redemption lifecycle guide.
Authorizations
ApiKeyAuthBearerAuth
API key passed in the X-API-Key header.
Path Parameters
Participant ID
Query Parameters
Maximum number of results (default 50, max 200)
Required range:
x >= 1Pagination cursor from previous response
Filter by redemption status
Available options:
PENDING, COMPLETED, FAILED, CANCELLED, PARTIALLY_REVERSED, FULLY_REVERSED Filter by reward catalog item ID
Start of creation-time window (RFC 3339)
End of creation-time window (RFC 3339)