Choose a version:

StoreCreditAccountTransaction

interface

Requires read_store_credit_account_transactions access scope.

Interface for a store credit account transaction.

Anchor to FieldsFields

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

StoreCreditAccountCreditTransaction

•OBJECT

A credit transaction which increases the store credit account balance.

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to expiresAtexpiresAt •DateTime: The time at which the transaction expires. Debit transactions will always spend the soonest expiring credit first.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.
Anchor to remainingAmountremainingAmount •MoneyV2! non-null: The remaining amount of the credit. The remaining amount will decrease when a debit spends this credit. It may also increase if that debit is subsequently reverted. In the event that the credit expires, the remaining amount will represent the amount that remained as the expiry ocurred.

StoreCreditAccountDebitRevertTransaction

•OBJECT

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.

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to debitTransactiondebitTransaction •StoreCreditAccountDebitTransaction! non-null: The reverted debit transaction.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.

StoreCreditAccountDebitTransaction

•OBJECT

A debit transaction which decreases the store credit account balance.

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.

StoreCreditAccountExpirationTransaction

•OBJECT

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.

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to creditTransactioncreditTransaction •StoreCreditAccountCreditTransaction! non-null: The credit transaction which expired.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.

Was this section helpful?