Skip to content

CardLedgerTransactionLogEntryIntegrationAPI.md

Latest commit

 

History

History
46 lines (40 loc) · 2.7 KB

CardLedgerTransactionLogEntryIntegrationAPI.md

File metadata and controls

46 lines (40 loc) · 2.7 KB

TalonOne::CardLedgerTransactionLogEntryIntegrationAPI

Properties

Name Type Description Notes
transaction_uuid String Unique identifier of the transaction in the UUID format.
created Time Date and time the loyalty card transaction occurred.
program_id Integer ID of the loyalty program.
card_identifier String The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.
customer_session_id String ID of the customer session where the transaction occurred. [optional]
type String Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points.
name String Name or reason of the loyalty ledger transaction.
start_date String When points become active. Possible values: - `immediate`: Points are active immediately. - `on_action`: Points become active based on the customer's action. - a timestamp value: Points become active at a given date and time.
expiry_date String Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date.
subledger_id String ID of the subledger.
amount Float Amount of loyalty points added or deducted in the transaction.
id Integer ID of the loyalty ledger transaction.
ruleset_id Integer The ID of the ruleset containing the rule that triggered this effect. [optional]
rule_name String The name of the rule that triggered this effect. [optional]
validity_duration String The duration for which the points remain active, relative to the activation date. Note: This only applies to points for which `awaitsActivation` is `true` and `expiryDate` is not set. [optional]

Example

require 'talon_one_sdk'

instance = TalonOne::CardLedgerTransactionLogEntryIntegrationAPI.new(
  transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
  created: 2022-01-02T15:04:05Z07:00,
  program_id: 324,
  card_identifier: summer-loyalty-card-0543,
  customer_session_id: 05c2da0d-48fa-4aa1-b629-898f58f1584d,
  type: addition,
  name: Reward 10% points of a purchase's current total,
  start_date: 2022-01-02T15:04:05Z07:00,
  expiry_date: 2022-08-02T15:04:05Z07:00,
  subledger_id: sub-123,
  amount: 10.25,
  id: 123,
  ruleset_id: 11,
  rule_name: Add 2 points,
  validity_duration: 30D
)