curl --request POST \
--url https://api.develop.fourdos.dev/v1/users/{userId}/redeem \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"reward_id": "<string>"
}
'import requests
url = "https://api.develop.fourdos.dev/v1/users/{userId}/redeem"
payload = { "reward_id": "<string>" }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reward_id: '<string>'})
};
fetch('https://api.develop.fourdos.dev/v1/users/{userId}/redeem', 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.develop.fourdos.dev/v1/users/{userId}/redeem",
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([
'reward_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.develop.fourdos.dev/v1/users/{userId}/redeem"
payload := strings.NewReader("{\n \"reward_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.develop.fourdos.dev/v1/users/{userId}/redeem")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reward_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.develop.fourdos.dev/v1/users/{userId}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reward_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": "<string>",
"org_id": "<string>",
"reward_id": "<string>",
"amount": "<string>",
"status": "pending",
"burn_ledger_entry_id": "<string>",
"onchain_job_id": "<string>",
"fulfilled_at": "2023-11-07T05:31:56Z",
"code": "<string>",
"code_used_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}Claim a reward for a member
Checks the reward’s cap, stock and tier and the member’s balance, then burns the XP and records the claim in one transaction. A refused claim writes nothing. Idempotency-Key is required: retrying with the same key and body replays the original claim instead of burning twice. Keys are scoped to your organization, so the same key for a different member or reward is a conflict. A member session may name only its own user id; another id answers 404.
curl --request POST \
--url https://api.develop.fourdos.dev/v1/users/{userId}/redeem \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"reward_id": "<string>"
}
'import requests
url = "https://api.develop.fourdos.dev/v1/users/{userId}/redeem"
payload = { "reward_id": "<string>" }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reward_id: '<string>'})
};
fetch('https://api.develop.fourdos.dev/v1/users/{userId}/redeem', 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.develop.fourdos.dev/v1/users/{userId}/redeem",
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([
'reward_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.develop.fourdos.dev/v1/users/{userId}/redeem"
payload := strings.NewReader("{\n \"reward_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.develop.fourdos.dev/v1/users/{userId}/redeem")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reward_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.develop.fourdos.dev/v1/users/{userId}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reward_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": "<string>",
"org_id": "<string>",
"reward_id": "<string>",
"amount": "<string>",
"status": "pending",
"burn_ledger_entry_id": "<string>",
"onchain_job_id": "<string>",
"fulfilled_at": "2023-11-07T05:31:56Z",
"code": "<string>",
"code_used_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}Authorizations
Organization API key (org_...) sent as Authorization: Bearer <key>. Keys are scoped to one organization; every request operates within that tenant.
Headers
Required. Tie it to one claim attempt.
1Path Parameters
Body
1Response
The claim, or the original claim replayed for a retried key
A non-negative integer as a decimal string.
pending, burned, fulfilled, failed The single-use code a code reward issued; null for every other reward.
Null while the code is still usable.