Skip to main content
​
id
string
required
Pattern: ^rdm_[a-f0-9]{24}$
Example:

"rdm_663a1b9c8e4f2a0012abcd34"

​
status
enum<string>
required

Lifecycle status of the redemption aggregate.

Available options:
draft,
reserved,
confirmed,
failed
​
version
integer
required

Resource version for optimistic concurrency. Starts at 1 on creation and increments on every state change. Use the latest value when reconciling concurrent updates.

Required range: x >= 1
Example:

3

​
amount
integer
required

Requested amount in cents.

​
reversed_amount
integer
required

Amount reversed back to the provider in cents.

​
currency
string
required
Required string length: 3
Example:

"ZAR"

​
operations
object[]
required
​
related_ids
string[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
type
enum<string>

Namespaced redemption type in category.type form. The category selects the value class and the suffix selects the specific provider that will fulfil the redemption.

Only the vouchers category is available today. Loyalty point categories (for example loyalty_points.skywards, loyalty_points.ebucks) are planned.

Available options:
vouchers.one_voucher,
vouchers.ott,
vouchers.blu
​
provider_reference
object

Latest provider side reference bag. Shape depends on the most recent operation.

​
reserved_amount
integer

Amount currently reserved against the provider in cents.

​
redeemed_amount
integer

Amount captured by the provider in cents. May differ from amount on partial redeems.

​
source
1Voucher · object

Provider specific source credential object that identifies the voucher being redeemed. The shape is owned by the adapter and selected by the parent type field.

​
redemption_options
object

Provider specific configuration bag forwarded on each operation.

​
change_voucher
1Voucher · object

Replacement voucher issued by the provider when a partial redemption is performed (redeemed amount less than the original voucher value). Populated by 1Voucher and Blu today. The shape is selected by the redemption type.

Customer must keep pin to spend the remainder. amount, when present, is in cents. Blu does not return an amount for the replacement voucher, so the field is omitted. Caller can issue a stored value lookup against pin for the balance.

​
last_error
object

Provider mapped error attached to a failed operation or to a failed redemption aggregate.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. NEW Limitations:

  • Maximum 20 keys
  • Key names must be strings (max 40 characters)
  • Values must be strings (max 500 characters)
Example:
{
  "customer_id": "cust_123456",
  "order_id": "ord_789012"
}
​
external_reference
string