Cancel a pending redemption
Release the reservation backing a pending redemption and mark it cancelled. Replaying an already-cancelled redemption returns the same record.
PENDING redemption as CANCELLED and releases its live reserved value from HELD to AVAILABLE. Include an optional reason to record why fulfillment stopped.
Reserved LOT value can expire before cancellation. The endpoint releases only the live remainder and never recreates expired value. Repeating cancellation returns the stored redemption; a different terminal outcome returns 409 redemption_already_resolved.
Authorizations
API key passed in the X-API-Key header.
Path Parameters
Redemption ID
Body
Cancellation details
Response
Redemption cancelled or same-outcome replay
Total amount debited from the participant's balance (decimal string)
"1000.00"
The asset that was debited
"550e8400-e29b-41d4-a716-446655440003"
Ledger entry that captured a pending redemption
"550e8400-e29b-41d4-a716-446655440007"
When the pending redemption was captured
"2024-01-15T10:45:00Z"
When this redemption was created
"2024-01-15T10:30:00Z"
Context for this redemption, used in journal entries
"Redeemed: Gift Card"
Effective deadline of the backing reservation. Always present for pending redemptions; defaults to 90 days and may be configured up to one year.
"2024-01-15T11:30:00Z"
Machine-readable or operator-supplied terminal failure detail
"fulfillment_failed"
Unique identifier for this redemption
"550e8400-e29b-41d4-a716-446655440000"
Immutable ledger anchor: the hold entry for pending redemptions, otherwise the instant redemption entry
"550e8400-e29b-41d4-a716-446655440005"
The participant who redeemed
"550e8400-e29b-41d4-a716-446655440002"
The program this redemption belongs to
"550e8400-e29b-41d4-a716-446655440001"
Number of units redeemed (catalog redemptions only)
2
Reservation backing a pending redemption
"550e8400-e29b-41d4-a716-446655440006"
When the pending redemption reached a terminal state
"2024-01-15T10:45:00Z"
Cumulative amount reversed so far (decimal string)
"0.00"
Cumulative units reversed so far (UNIT_BASED catalog redemptions only)
0
The reward catalog item that was redeemed (catalog redemptions only)
"550e8400-e29b-41d4-a716-446655440004"
Current lifecycle and reversal state
PENDING, COMPLETED, FAILED, CANCELLED, PARTIALLY_REVERSED, FULLY_REVERSED "COMPLETED"
Cost per unit at the time of redemption (catalog redemptions only, decimal string)
"500.00"
When this redemption was last updated (e.g., after a reversal)
"2024-01-15T10:30:00Z"