Transaction Object

Transaction is the secondary entity of GiftCardService that indicate an action that modifies the balance of a gift card.

Properties
idstringRead-onlyformat GUID

Transaction unique id.

createdDatestringRead-onlyformat date-time

Transaction creation date.

typestring

Type of transaction.

giftCardIdstringformat GUIDimmutable

Unique ID of the gift card associated with this transaction.

amountstringformat DECIMAL_VALUEimmutabledecimalValue {"gt":"0","maxScale":2}

Transaction amount.

operationTypestringRead-only

Indicates whether the transaction adds or subtracts from the GiftCard balance.

idempotencyKeystringminLength 1maxLength 50immutable

Idempotency key, to prevent duplicate creation.

updatedBalancestringRead-onlyformat DECIMAL_VALUEdecimalValue {"gt":"0","maxScale":2}

Gift card Balance after this transaction operation.

sourceInfoSourceInfoimmutable

Information about the source of the transaction.

externalEventExternalEventimmutable

Information about an external event that lead to the transaction.

externalIdstringimmutablemaxLength 50

ID of the transaction in a 3rd party system if created there.

One Of
Choose one of the following parameters
redeemOptionsRedeemOptions

Information about a transaction whose source is a gift card redemption.

voidOptionsVoidOptions

Information about a transaction that comes to void a previous transaction.

rewardOptionsRewardOptionsdeprecated - use walletActionStartOptions instead

Reward Options.

walletActionEndOptionsWalletActionEndOptions

Information about a transaction whose source is the end of a wallet action (store credit).

campaignOptionsCampaignOptionsdeprecated - use bulkOptions instead

Bulk Options.

storeCreditRefundOptionsStoreCreditRefundOptionsdeprecated - use walletActionStartOptions instead

Information about a transaction whose source is a store credit refund.

migrationOptionsMigrationOptions

Information about a transaction whose source is a migration from Rise V1 or another platform.

paymentMethodRefundOptionsPaymentMethodRefundOptions

Information about a transaction whose source is a refunding a payment method.

initialOptionsInitialOptions

Information about the first transaction that initializes a gift card.

walletActionStartOptionsWalletActionStartOptions

Information about a transaction whose source is a wallet action (store credit) to a customer.

bulkOptionsBulkOptionsdeprecated - use walletActionStartOptions instead

Bulk Options.

manualOptionsManualOptions

Information about a transaction issued manually from the Rise dashboard.

Did this help?