Schema
iglooX Stored-Value Balance
A customer-owned stored-value balance available at the associated iglooX outlet. A balance can be returned even when it cannot currently be redeemed; check is_usable and available_balance.
Overview
Properties
uuid
string
Required
The customer balance UUID. Pass it unchanged as loyalty_balance_uuid when redeeming stored value.
Format
uuid
name
string
Required
Min length
1
Max length
255
description
string | null
Required
Max length
10000
Nullable
Yes
balance
reference
Required
The recorded balance, including value that may no longer be redeemable.
References Money.
available_balance
reference
Required
The value currently available for redemption. This can be zero while balance still contains value.
References Money.
state
string
Required
Allowed values
availableinsufficient_balanceexpirednot_yet_usablearchivedminimum_redemption_not_metis_usable
boolean
Required
Whether the balance is currently usable. An unusable balance may still have a recorded balance or existing redemptions.
usable_from
string
Required
Format
date-time
expires_at
string | null
Required
Format
date-time
Nullable
Yes
minimum_redemption_per_order
oneOf
Required
The minimum stored-value redemption allowed per order, if set.
Nullable
Yes
One of
One of 1
null
One of 2
reference
References Money.
Used by
Raw YAML
Download source
title: iglooX Stored-Value Balance
type: object
description: A customer-owned stored-value balance available at the associated iglooX outlet. A balance can be returned even when it cannot currently be redeemed; check is_usable and available_balance.
required:
- uuid
- name
- description
- balance
- available_balance
- state
- is_usable
- usable_from
- expires_at
- minimum_redemption_per_order
properties:
uuid:
type: string
format: uuid
description: The customer balance UUID. Pass it unchanged as loyalty_balance_uuid when redeeming stored value.
name:
type: string
minLength: 1
maxLength: 255
description:
type:
- string
- 'null'
maxLength: 10000
balance:
$ref: ./Money.yaml
description: The recorded balance, including value that may no longer be redeemable.
available_balance:
$ref: ./Money.yaml
description: The value currently available for redemption. This can be zero while balance still contains value.
state:
type: string
enum:
- available
- insufficient_balance
- expired
- not_yet_usable
- archived
- minimum_redemption_not_met
is_usable:
type: boolean
description: Whether the balance is currently usable. An unusable balance may still have a recorded balance or existing redemptions.
usable_from:
type: string
format: date-time
expires_at:
type:
- string
- 'null'
format: date-time
minimum_redemption_per_order:
oneOf:
- type: 'null'
- $ref: ./Money.yaml
description: The minimum stored-value redemption allowed per order, if set.
x-tags:
- iglooX Integration