Skip to content

Enum Definitions

Reference for enumeration values used across the RewardOS API.

Value Description
ACTIVE Brand is active; vouchers can be generated
INACTIVE Vouchers cannot be generated
Value Description
FIXED Only denominations in amountRestrictions.denominations
FLEXIBLE Any amount between min and max voucher amount
Value Description Display
CARD_NUMBER_SECURED Redeem with card number Show cardNumber only
PIN_NO_SECURED Redeem with PIN Show cardPin only
CARD_AND_PIN_NO_SECURED Needs both Show both
Value Description Display Suggestion
OFFLINE In-store only “In-Store Only”
ONLINE Online only “Online Only”
ONLINE_AND_OFFLINE Both “Online & In-Store”
Value Description Your Action
SUCCESS Vouchers in vouchers[] Display vouchers
FAILED Generation failed Error + new referenceId
PROCESSING Still generating Poll or webhook
CANCELLED Cancelled by client Confirm cancellation
REVERSED Reversed by client Handle refund if needed
Value Description
SELF Deliver to ordering customer
OTHER Deliver to a different recipient