Skip to main content
GET
/
v1
/
redemptions
/
{id}
Get redemption
curl --request GET \
  --url https://api.scrip.dev/v1/redemptions/{id} \
  --header 'X-API-Key: <api-key>'
import requests

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

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/redemptions/{id}', 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/redemptions/{id}",
  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/redemptions/{id}"

	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/redemptions/{id}")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

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

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
{
  "amount": "1000.00",
  "asset_id": "550e8400-e29b-41d4-a716-446655440003",
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Redeemed: Gift Card",
  "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,
  "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": "internal_error",
  "message": "An internal error occurred"
}
Returns a single redemption by its ID. The response includes the asset, amount, description, associated reward (for catalog redemptions), and reversal state. The status field is one of COMPLETED, PARTIALLY_REVERSED, or FULLY_REVERSED. Check reversed_amount to see how much headroom remains before issuing a partial reversal.
For usage patterns and examples, see the Redemptions guide.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Redemption ID

Response

Redemption details

​
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"

​
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"

​
id
string<uuid>

Unique identifier for this redemption

Example:

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

​
journal_entry_id
string<uuid>

The ledger journal entry created by this redemption

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

​
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
string

Current state: COMPLETED, PARTIALLY_REVERSED, or 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"