ShopifyPaymentsPayout

Required access

read_shopify_payments access scope

Payouts represent the movement of money between a merchant's Shopify Payments balance and their bank account.

Show definition
# Payouts represent the movement of money between a merchant's Shopify
# Payments balance and their bank account.
type ShopifyPaymentsPayout implements Node {
  # Globally unique identifier.
  id: ID!

  # The total gross amount and currency of the payout.
  gross: MoneyV2!

  # The exact time when the payout was issued. The payout only contains
  # balance transactions that were available at this time.
  issuedAt: DateTime!

  # The transfer status of the payout.
  status: ShopifyPaymentsPayoutStatus!

  # The summary of the payout.
  summary: ShopifyPaymentsPayoutSummary!
}

Implements

Fields

gross   (MoneyV2!)

The total gross amount and currency of the payout.

id   (ID!)

Globally unique identifier.

issuedAt   (DateTime!)

The exact time when the payout was issued. The payout only contains balance transactions that were available at this time.

status   (ShopifyPaymentsPayoutStatus!)

The transfer status of the payout.

summary   (ShopifyPaymentsPayoutSummary!)

The summary of the payout.

Sign up for a Partner account to get started.

Sign up