Discount Details

Available discount points balance and selectable discount options.

maxDiscountsintegerrequired

Maximum number of discounts that may be combined for one payment.

availablePoints object

Loyalty points balance available for use for the already evaluated discount options for this payment.

idstringrequired

Loyalty point ID (UUID). Same identifier used in the balance and reward-transactions APIs.

namestringrequired

Display name of the loyalty point (e.g. Redeemable Points, Member Points).

attributes object[]required

Key-value attributes for the loyalty point (e.g. overall, redeemable, type). Returns empty array when none are for the entity.

Array [

keystring

Attribute name (e.g. overall, redeemable, type).

valuestring

Attribute value for the key.

]

balanceintegerrequired

Current balance for this loyalty point for the profile.

options object[]

Selectable discount lines (points tiers, vouchers, or a no-discount option) with redemption metadata.

Array [

amountinteger<int64>required

Discount amount in minor currency units.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

typestringrequired

Discount source type.

Possible values: [POINTS, VOUCHER]

redemption object

Identifies a chosen discount option for redemption APIs (for example purchase-order discountDetails or transfer preview discounts). The presence of a redemption resource indicates whether the downstream business domain is responsible for debiting the customer's loyalty rewards. If redemption is not provided, the discount is applied as a fiat adjustment, and no loyalty rewards are debited.

referencestringrequired

Stable reference for this discount tier or voucher (for example points amount as a string, voucher code, or 0 for no discount).

displayNamestring

Customer-facing label for the discount option in UI copy.

]

Discount Details

{
  "maxDiscounts": 0,
  "availablePoints": {
    "id": "string",
    "name": "string",
    "attributes": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "balance": 0
  },
  "options": [
    {
      "amount": 0,
      "currencyCode": "EUR",
      "type": "POINTS",
      "redemption": {
        "reference": "string",
        "displayName": "string"
      }
    }
  ]
}