Transaction Object


A transaction represents a change to a gift card's balance, including redemptions, refunds, and initial value assignments. Transactions provide an audit trail of all gift card activity and cannot be modified once created.

Properties
amountAmountRead-only

Monetary amount of the transaction. Positive values represent credits, negative values represent debits.


createdDatestringRead-onlyformat date-time

Date and time the transaction was created.


giftCardIdstringRead-onlyformat GUID

Gift card ID associated with this transaction.


idstringRead-onlyformat GUID

Transaction ID.


operationTypestringRead-only

Whether the transaction adds to or subtracts from the gift card balance.


orderInfoOrderInfo

Order details when the transaction is related to an eCommerce purchase or refund.


typestringRead-only

Type of transaction indicating the reason for the balance change.


updatedBalanceAmountRead-only

Gift card balance after this transaction was applied.

Did this help?