Skip to main content
GET
Get a redemption

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

id
string
required

Response

200 - application/json
id
string
required
burn_tx_hash
string
required
log_index
number
required

Position of the burn within its transaction. With burn_tx_hash it identifies the burn.

burn_time
string
required
amount
string
required
redeeming_address
string
required
deadline
string
required
state
enum<string>
required
Available options:
pending,
done,
done_late,
failed
late
boolean
required
reportable
boolean
required
step
string
required
payout_reference
string | null
source_ref
string | null

Statement reference (source_ref). Stored and shown; never used to match.

payout_date
string | null
payout_source
enum<string> | null
Available options:
csv,
api,
manual
case_resolution
enum<string> | null
Available options:
dismissed,
paid
resolved_by
string | null
dismiss_reason
string | null
waiting_for
string | null
payout_entered_by
string | null
payout_entered_at
string | null
case_id
string | null

The case opened when this redemption missed its deadline. Null when no case was opened.

Last modified on October 7, 2026