HTTP endpoints
listRewardDeliveries
Delivery attempts and delivery debts for one reward.
GET /api/v1/rewards/{rewardId}/deliveries
Requires rewards:deliver. Keep the Bearer key on your server.
SDK
ts
grizzlee.listRewardDeliveries(rewardId: string): Promise<RewardDeliveryHistory>HTTP
Use your backend's HTTP client. The cURL request shows the wire format. Replace path parameters and example values.
sh
curl --fail-with-body --request GET \
'https://app.grizzlee.ca/api/v1/rewards/{rewardId}/deliveries' \
-H "Authorization: Bearer $GRIZZLEE_SERVER_KEY"Response
HTTP responses wrap this value in data. The SDK returns the value directly unless the note above describes a wrapper.
| Field | Type | Required | Details |
|---|---|---|---|
rewardId | string | Yes | |
deliveryMode | union | Yes | |
deliveries | array | Yes | Oldest first. |
debts | array | Yes | Debts from reversals after delivery, oldest first. |
deliveryMode
Variant 1
Type: string.
Variant 2
Type: string.
deliveries[]
| Field | Type | Required | Details |
|---|---|---|---|
deliveries.id | string | Yes | |
deliveries.companyId | string | Yes | |
deliveries.rewardId | string | Yes | |
deliveries.partnerId | string | Yes | |
deliveries.status | union | Yes | |
deliveries.externalReference | string | No | New attempts require a reference. Older failures may have none. |
deliveries.amountCents | number | Yes | Gross amount delivered, amount owed for a failure, or cash returned by a transfer reversal. |
deliveries.currency | union | Yes | |
deliveries.rewardType | union | Yes | |
deliveries.deliveredAt | string | No | Present when delivered. |
deliveries.failureReason | string | No | Present when failed. |
deliveries.nettedDebtCents | number | No | Present when a delivery settled part of the partner's earlier delivery debt. |
deliveries.payoutId | string | No | Present when a paid merchant payout recorded this delivery. |
deliveries.reversalOfId | string | No | Original delivery this append-only transfer reversal reduces. |
deliveries.createdAt | string | Yes |
deliveries.status
Variant 1
Type: string.
Variant 2
Type: string.
Variant 3
Type: string.
deliveries.currency
Variant 1
Type: string.
Variant 2
Type: string.
Variant 3
Type: string.
Variant 4
Type: string.
deliveries.rewardType
Variant 1
Type: string.
Variant 2
Type: string.
debts[]
| Field | Type | Required | Details |
|---|---|---|---|
debts.outstandingCents | number | Yes | amountCents minus every settlement. |
debts.settlements | array | Yes | |
debts.id | string | Yes | |
debts.companyId | string | Yes | |
debts.partnerId | string | Yes | |
debts.rewardId | string | Yes | |
debts.deliveryId | string | Yes | The delivered record the reversal applies to. |
debts.eventId | string | Yes | Refund event that reversed the delivered amount. |
debts.currency | union | Yes | |
debts.rewardType | union | Yes | |
debts.amountCents | number | Yes | |
debts.createdAt | string | Yes |
debts.settlements[]
| Field | Type | Required | Details |
|---|---|---|---|
debts.settlements.id | string | Yes | |
debts.settlements.companyId | string | Yes | |
debts.settlements.debtId | string | Yes | |
debts.settlements.partnerId | string | Yes | |
debts.settlements.kind | union | Yes | |
debts.settlements.amountCents | number | Yes | |
debts.settlements.externalReference | string | No | Present on recovered settlements. |
debts.settlements.deliveryId | string | No | Present on netted settlements. |
debts.settlements.eventId | string | No | Reward restoration or transfer reversal event. Present on restored settlements. |
debts.settlements.createdAt | string | Yes |
debts.settlements.kind
Variant 1
Type: string.
Variant 2
Type: string.
Variant 3
Type: string.
debts.currency
Variant 1
Type: string.
Variant 2
Type: string.
Variant 3
Type: string.
Variant 4
Type: string.
debts.rewardType
Variant 1
Type: string.
Variant 2
Type: string.
Response schema
json
{
"type": "object",
"properties": {
"rewardId": {
"type": "string"
},
"deliveryMode": {
"anyOf": [
{
"type": "string",
"const": "grizzlee_wallet"
},
{
"type": "string",
"const": "merchant"
}
]
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"companyId": {
"type": "string"
},
"rewardId": {
"type": "string"
},
"partnerId": {
"type": "string"
},
"status": {
"anyOf": [
{
"type": "string",
"const": "reversed"
},
{
"type": "string",
"const": "delivered"
},
{
"type": "string",
"const": "failed"
}
]
},
"externalReference": {
"type": "string",
"description": "New attempts require a reference. Older failures may have none."
},
"amountCents": {
"type": "number",
"description": "Gross amount delivered, amount owed for a failure, or cash returned by a transfer reversal."
},
"currency": {
"anyOf": [
{
"type": "string",
"const": "CAD"
},
{
"type": "string",
"const": "USD"
},
{
"type": "string",
"const": "EUR"
},
{
"type": "string",
"const": "GBP"
}
]
},
"rewardType": {
"anyOf": [
{
"type": "string",
"const": "cash"
},
{
"type": "string",
"const": "credit"
}
]
},
"deliveredAt": {
"type": "string",
"description": "Present when delivered."
},
"failureReason": {
"type": "string",
"description": "Present when failed."
},
"nettedDebtCents": {
"type": "number",
"description": "Present when a delivery settled part of the partner's earlier delivery debt."
},
"payoutId": {
"type": "string",
"description": "Present when a paid merchant payout recorded this delivery."
},
"reversalOfId": {
"type": "string",
"description": "Original delivery this append-only transfer reversal reduces."
},
"createdAt": {
"type": "string"
}
},
"required": [
"id",
"companyId",
"rewardId",
"partnerId",
"status",
"amountCents",
"currency",
"rewardType",
"createdAt"
]
},
"description": "Oldest first."
},
"debts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outstandingCents": {
"type": "number",
"description": "amountCents minus every settlement."
},
"settlements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"companyId": {
"type": "string"
},
"debtId": {
"type": "string"
},
"partnerId": {
"type": "string"
},
"kind": {
"anyOf": [
{
"type": "string",
"const": "restored"
},
{
"type": "string",
"const": "netted"
},
{
"type": "string",
"const": "recovered"
}
]
},
"amountCents": {
"type": "number"
},
"externalReference": {
"type": "string",
"description": "Present on recovered settlements."
},
"deliveryId": {
"type": "string",
"description": "Present on netted settlements."
},
"eventId": {
"type": "string",
"description": "Reward restoration or transfer reversal event. Present on restored settlements."
},
"createdAt": {
"type": "string"
}
},
"required": [
"id",
"companyId",
"debtId",
"partnerId",
"kind",
"amountCents",
"createdAt"
]
}
},
"id": {
"type": "string"
},
"companyId": {
"type": "string"
},
"partnerId": {
"type": "string"
},
"rewardId": {
"type": "string"
},
"deliveryId": {
"type": "string",
"description": "The delivered record the reversal applies to."
},
"eventId": {
"type": "string",
"description": "Refund event that reversed the delivered amount."
},
"currency": {
"anyOf": [
{
"type": "string",
"const": "CAD"
},
{
"type": "string",
"const": "USD"
},
{
"type": "string",
"const": "EUR"
},
{
"type": "string",
"const": "GBP"
}
]
},
"rewardType": {
"anyOf": [
{
"type": "string",
"const": "cash"
},
{
"type": "string",
"const": "credit"
}
]
},
"amountCents": {
"type": "number"
},
"createdAt": {
"type": "string"
}
},
"required": [
"outstandingCents",
"settlements",
"id",
"companyId",
"partnerId",
"rewardId",
"deliveryId",
"eventId",
"currency",
"rewardType",
"amountCents",
"createdAt"
]
},
"description": "Debts from reversals after delivery, oldest first."
}
},
"required": [
"rewardId",
"deliveryMode",
"deliveries",
"debts"
]
}Errors
Failures return { "error": { "code": "...", "message": "...", "details": {} } }. Details are optional. See error statuses. Reuse an unchanged event payload when retrying.