Post a transaction (stamp / redeem / adjust)
curl --request POST \
--url https://dashboard.perkstar.co.uk/api/v1/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enrollment_id": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enrollment_id: '<string>'})
};
fetch('https://dashboard.perkstar.co.uk/api/v1/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://dashboard.perkstar.co.uk/api/v1/transactions"
payload = { "enrollment_id": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dashboard.perkstar.co.uk/api/v1/transactions",
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([
'enrollment_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "<string>",
"enrollment_id": "<string>",
"type": "STAMP",
"source": "SCANNER",
"delta": 123,
"amount_pence": 123,
"note": "<string>",
"external_id": "<string>",
"external_transaction_id": "<string>",
"reverses_transaction_id": "<string>",
"reason_text": "<string>",
"test_mode": true,
"created_at": "2023-11-07T05:31:56Z",
"enrollment": {
"id": "<string>",
"balance": 123,
"redemptions_count": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Replay-safe request key. Repeated requests with the same value within 24h return the original response unchanged.
255Body
STAMP, REDEEM, ADJUST x <= 100000Must be a multiple of 0.01x >= 0280120Stable partner-side identifier used for permanent
organization-wide deduplication. Use a namespace owned by your
app; provider-managed prefixes such as sq_payment_ are reserved.
180Response
Created
STAMP, REDEEM, ADJUST SCANNER, POS, API, ADJUST, DASHBOARD, LEGACY_IMPORT, TAP 0.01Partner-supplied stable identifier (Toast order id,
Shopify checkout id, Square payment id). When set on
create via POST /transactions or
POST /marketplace/accrue, the unique
(orgId, externalTransactionId) index makes the call
permanently idempotent — a redelivered upstream webhook
returns the existing row at HTTP 200 instead of
double-crediting. Provider-owned prefixes such as sq_payment_
are reserved for managed integrations.
Set on a compensating row created by
/marketplace/reverse. Points at the original transaction
this row reverses. The original is reversed at most once
(enforced by a unique constraint).
Operator-visible reason for a reversal ("Customer refunded the order"). Persisted on the COMPENSATING row, not the original.
True when posted via a pk_test_… key. Test rows still
write to the ledger and still fire webhooks (so partner
sandbox integrations can verify their receivers), but DO
NOT update Customer / Card / Enrollment aggregates and
are excluded from operator dashboard rollups.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://dashboard.perkstar.co.uk/api/v1/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enrollment_id": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enrollment_id: '<string>'})
};
fetch('https://dashboard.perkstar.co.uk/api/v1/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://dashboard.perkstar.co.uk/api/v1/transactions"
payload = { "enrollment_id": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dashboard.perkstar.co.uk/api/v1/transactions",
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([
'enrollment_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "<string>",
"enrollment_id": "<string>",
"type": "STAMP",
"source": "SCANNER",
"delta": 123,
"amount_pence": 123,
"note": "<string>",
"external_id": "<string>",
"external_transaction_id": "<string>",
"reverses_transaction_id": "<string>",
"reason_text": "<string>",
"test_mode": true,
"created_at": "2023-11-07T05:31:56Z",
"enrollment": {
"id": "<string>",
"balance": 123,
"redemptions_count": 123
}
}