Enum Definitions
Reference for all enumeration values used across the Hubble API.
Product Status
Status field in get brand APIs
| Value | Description |
|---|---|
ACTIVE | Brand is active, vouchers can be generated for the brand |
INACTIVE | Vouchers cannot be generated for the brand |
Denomination Type
Present in brand APIs
| Value | Description |
|---|---|
FIXED | Vouchers can only be generated for the denominations provided in amountRestrictions.denominations |
FLEXIBLE | Voucher of any amount between the specified min-max can be generated |
Card Type
Credentials needed by customer to redeem the voucher
| Value | Description | What to Display |
|---|---|---|
CARD_NUMBER_SECURED | User can just use the card number while redeeming | Show cardNumber only |
PIN_NO_SECURED | User can just use the card PIN while redeeming | Show cardPin only |
CARD_AND_PIN_NO_SECURED | User needs to use both card number and PIN to redeem | Show both cardNumber and cardPin |
Redemption Type
Mode of redemption
| Value | Description | Display Suggestion |
|---|---|---|
OFFLINE | Voucher can be used only at offline stores | "In-Store Only" |
ONLINE | Voucher can only be used online | "Online Only" |
ONLINE_AND_OFFLINE | Voucher can be redeemed at both online and offline stores | "Online & In-Store" |
Order Status
Status returned on get order and place order APIs
| Value | Description | Your Action |
|---|---|---|
SUCCESS | Voucher generation is successful, voucher data will be present in the vouchers list | Display vouchers to user |
FAILED | Voucher generation failed | Show error message, retry with new referenceId |
PROCESSING | Voucher is being generated, status can be polled or listen to webhook | Poll or wait for webhook |
CANCELLED | Voucher is cancelled as per client request | Confirm cancellation |
REVERSED | Voucher is reversed as per client request | Process refund if applicable |
Recipient Type
Used in delivery details
| Value | Description |
|---|---|
SELF | Recipient is the same as the customer |
OTHER | Recipient is different from the customer |
Delivery Channel
Communication channels for voucher delivery
| Value | Description | Requirement |
|---|---|---|
EMAIL | Send voucher via email | Requires valid customerDetails.email |
SMS | Send voucher via SMS | Requires valid phone number |
WHATSAPP | Send voucher via WhatsApp | Requires valid phone number |