Overview
Get Reward
Retrieve details about a reward sent to a ZBD user
GET
Get Reward
Track and verify rewards sent to your users. This endpoint provides complete transaction details including status, fees, and confirmation times.
When to Use This
Verify Delivery
Confirm rewards reached the intended recipient
Track Performance
Build reward dashboards and reports with transaction data
Handle Support
Investigate user inquiries about rewards
Audit Trail
Maintain records for accounting and compliance
Configuration
Path Parameters
Transaction ID from the Send Reward response
Example: "78fb6474-d791-47a1-bda1-a4b9023898c0"
Header Parameters
Your ZBD Project API Key
Code Examples
Response
Response Fields
Field | Type | Description |
---|---|---|
id | string | Unique transaction identifier |
receiverId | string | Recipient’s ZBD User ID |
amount | string | Reward amount in millisatoshis |
fee | string | Network fee in millisatoshis |
unit | string | Always “msats” |
processedAt | string | When transaction was initiated |
confirmedAt | string | When reward was delivered |
comment | string | Description sent with reward |
status | string | Transaction status (see below) |
Status Values
Status | Description |
---|---|
TRANSACTION_STATUS_COMPLETED | Reward successfully delivered |
TRANSACTION_STATUS_PENDING | Processing (rare for gamertag payments) |
TRANSACTION_STATUS_FAILED | Reward failed to deliver |
Instant Verification - Rewards sent to gamertags are confirmed within milliseconds. The status will almost always be COMPLETED
when you check.
Get Reward