WalletAction is the main entity of WalletActionService. It represents a Store Credit that adds to the balance of a customer's wallet. It contains information about the amount and expiration date (if applicable) of the Store Credit, the context of its source (e.g. refund, workflow, etc.), and its status.
WalletAction ID.
Represents the current state of an item. Each time the item is modified, its revision changes. For an update operation to succeed, you MUST pass the latest revision.
Represents the time this WalletAction was created.
Represents the time this WalletAction was last updated.
Represents the time at which the WalletAction's amount will be added to the account. Defaults to immediately.
Represents the time at which the unused balance of the WalletAction will be deducted from the account. Defaults to never.
Represents the time at which the WalletAction was manually disabled, if applicable.
The amount to be added to the Wallet.
Free text comment regarding the WalletAction context
Indicates the kind of the specific WalletAction
Details about the WalletAction's execution, such as transaction ID and execution date. Set when the WalletAction is executed (e.g., when the amount is added to the account).
Details about the execution of the ending of the wallet action (due to expiration, disabling, etc), such as transaction ID and execution date. Set when the WalletAction is ended (i.e. when the amount is deducted from the account).
The current status of the WalletAction. Set to PENDING when the WalletAction is created and updated to ACTIVE when the amount is added to the wallet.
Information about the initiator of the WalletAction, such as the app or user that initiated the action. Set when the WalletAction is created.
Settings of the notifications related to the WalletAction. This field is used to specify whether to skip email dispatch or override the template ID for email notifications.
Indicates whether the WalletAction is a liability. The default is false.
Detailed information about the context of a store credit, such as the issuer type and sales channel.
Information about the external event that triggered the WalletAction, such as type of event and a short description or identifier of the event.
ID of the wallet to which the WalletAction belongs.
Unique key to identify the WalletAction, used to prevent duplicate WalletActions from being created in case of retries or network issues. The key should be unique for each WalletAction and should not be reused.