Skip to main content
Anchor to StoreCreditAccountCreditTransaction

StoreCreditAccountCreditTransaction

object

Requires read_store_credit_account_transactions access scope.

A credit transaction which increases the store credit account balance.

•StoreCreditAccount!
non-null

The store credit account that the transaction belongs to.

•MoneyV2!
non-null

The amount of the transaction.

Anchor to balanceAfterTransactionbalanceAfterTransaction
•MoneyV2!
non-null

The balance of the account after the transaction.

•DateTime!
non-null

The date and time when the transaction was created.

•StoreCreditSystemEvent!
non-null

The event that caused the store credit account transaction.

•DateTime

The time at which the transaction expires. Debit transactions will always spend the soonest expiring credit first.

•ID!
non-null

A globally-unique ID.

•StoreCreditAccountTransactionOrigin

The origin of the store credit account transaction.

•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.


Was this section helpful?

•mutation

Adds funds to a StoreCreditAccount by creating a StoreCreditAccountCreditTransaction. The mutation accepts either a store credit account ID, a Customer ID, or a CompanyLocation ID. When you provide a customer or company location ID, it automatically creates an account if one doesn't exist for the specified currency.

Store credit accounts are currency-specific. A single owner can have multiple accounts, each holding a different currency. Use the most appropriate currency for the given store credit account owner.

Credits can optionally include an expiration date.

Arguments

•ID!
required

The ID of the store credit account or the ID of the account owner.

•StoreCreditAccountCreditInput!
required

The input fields for a store credit account credit transaction.



Was this section helpful?

•interface

Was this section helpful?