Skip to main content
Anchor to ShopifyPaymentsBalanceTransaction

ShopifyPaymentsBalanceTransaction

object

Requires The user must have the view_payouts permission.

A transaction that contributes to a Shopify Payments account balance. Records money movement from charges, refunds, payouts, adjustments, or other payment activities. Includes the gross amount, processing fees, and resulting net amount that affects the account balance. Links to the source of the transaction and associated ShopifyPaymentsPayout details, with optional references to Order objects or adjustment reasons when applicable.

•JSON

The metadata for the adjustment that's associated with the transaction. If the source_type isn't an adjustment, the value will be null.

•String

The reason for the adjustment that's associated with the transaction. If the source_type isn't an adjustment, the value will be null.

•[ShopifyPaymentsAdjustmentOrder!]!
non-null

The adjustment orders associated to the transaction.

Show fields
•MoneyV2!
non-null

The amount contributing to the balance transaction.

Show fields
•ShopifyPaymentsAssociatedOrder

The associated order for the balance transaction.

Show fields
•ShopifyPaymentsBalanceTransactionAssociatedPayout!
non-null

Payout assoicated with the transaction.

Show fields
•String!
non-null

The user-friendly display name for the transaction type. This matches the Type column in the transaction CSV export from Finance > Transactions in the Shopify Admin.

•MoneyV2!
non-null

The fee amount contributing to the balance transaction.

Show fields
•ID!
non-null

A globally-unique ID.

•MoneyV2!
non-null

The net amount contributing to the merchant's balance.

Show fields
•BigInt

The ID of the resource leading to the transaction.

Anchor to sourceOrderTransactionIdsourceOrderTransactionId
•BigInt

The id of the Order Transaction

that resulted in this balance transaction.

•ShopifyPaymentsSourceType

The source type of the balance transaction.

Show enum values
•Boolean!
non-null

Wether the tranaction was created in test mode.

•DateTime!
non-null

The date and time when the balance transaction was processed.

•ShopifyPaymentsTransactionType!
non-null

The type of transaction.

Show enum values

Was this section helpful?

•interface

Was this section helpful?