Store Credit System Event
The event that caused the store credit account transaction.
Anchor to Valid valuesValid values
- Anchor to ADJUSTMENTADJUSTMENT
An adjustment was made to the store credit account.
- Anchor to ORDER_CANCELLATIONORDER_
CANCELLATION Store credit was returned when an authorized payment was voided.
- Anchor to ORDER_PAYMENTORDER_
PAYMENT Store credit was used as payment for an order.
- Anchor to ORDER_REFUNDORDER_
REFUND Store credit was refunded from an order.
- Anchor to PAYMENT_FAILUREPAYMENT_
FAILURE A store credit payment was reverted due to another payment method failing.
- Anchor to PAYMENT_RETURNEDPAYMENT_
RETURNED A smaller amount of store credit was captured than was originally authorized.
- Anchor to TAX_FINALIZATIONTAX_
FINALIZATION Tax finalization affected the store credit payment.
Anchor to FieldsFields
- •OBJECT
A credit transaction which increases the store credit account balance.
- Anchor to StoreCreditAccountDebitRevertTransaction.eventStore•OBJECT
Credit Account Debit Revert Transaction. event A debit revert transaction which increases the store credit account balance. Debit revert transactions are created automatically when a store credit account debit transaction is reverted.
Store credit account debit transactions are reverted when an order is cancelled, refunded or in the event of a payment failure at checkout. The amount added to the balance is equal to the amount reverted on the original credit.
- •OBJECT
A debit transaction which decreases the store credit account balance.
- Anchor to StoreCreditAccountExpirationTransaction.eventStore•OBJECT
Credit Account Expiration Transaction. event An expiration transaction which decreases the store credit account balance. Expiration transactions are created automatically when a store credit account credit transaction expires.
The amount subtracted from the balance is equal to the remaining amount of the credit transaction.
- •INTERFACE
Interface for a store credit account transaction.