ShopifyPaymentsPayout object

This page was printed on Jan 20, 2020. For the current version, visit https://help.shopify.com/en/api/graphql-admin-api/reference/object/shopifypaymentspayout.
Version 2020-04 (Release candidate)

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

Required access

read_shopify_payments access scope

Fields

bankAccount (ShopifyPaymentsBankAccount!)

The bank account for 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.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
net (MoneyV2!)

The total amount and currency of the payout.
status (ShopifyPaymentsPayoutStatus!)

The transfer status of the payout.
summary (ShopifyPaymentsPayoutSummary!)

The summary of the payout.
transactionType (ShopifyPaymentsPayoutTransactionType!)

The direction of the payout.

Types that return ShopifyPaymentsPayout

Implements

Deprecated fields

Show/Hide
gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2020-01 (Latest)

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

Required access

read_shopify_payments access scope

Fields

bankAccount (ShopifyPaymentsBankAccount!)

The bank account for 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.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
net (MoneyV2!)

The total amount and currency of the payout.
status (ShopifyPaymentsPayoutStatus!)

The transfer status of the payout.
summary (ShopifyPaymentsPayoutSummary!)

The summary of the payout.
transactionType (ShopifyPaymentsPayoutTransactionType!)

The direction of the payout.

Types that return ShopifyPaymentsPayout

Implements

Deprecated fields

Show/Hide
gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2019-10

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

Required access

read_shopify_payments access scope

Fields

bankAccount (ShopifyPaymentsBankAccount!)

The bank account for 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.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
net (MoneyV2!)

The total amount and currency of the payout.
status (ShopifyPaymentsPayoutStatus!)

The transfer status of the payout.
summary (ShopifyPaymentsPayoutSummary!)

The summary of the payout.
transactionType (ShopifyPaymentsPayoutTransactionType!)

The direction of the payout.

Types that return ShopifyPaymentsPayout

Implements

Deprecated fields

Show/Hide
gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2019-07

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

Required access

read_shopify_payments access scope

Fields

bankAccount (ShopifyPaymentsBankAccount!)

The bank account for 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.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
net (MoneyV2!)

The total amount and currency of the payout.
status (ShopifyPaymentsPayoutStatus!)

The transfer status of the payout.
summary (ShopifyPaymentsPayoutSummary!)

The summary of the payout.
transactionType (ShopifyPaymentsPayoutTransactionType!)

The direction of the payout.

Types that return ShopifyPaymentsPayout

Implements

Deprecated fields

Show/Hide
gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2019-04

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

Required access

read_shopify_payments access scope

Fields

bankAccount (ShopifyPaymentsBankAccount!)

The bank account for 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.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
net (MoneyV2!)

The total amount and currency of the payout.
status (ShopifyPaymentsPayoutStatus!)

The transfer status of the payout.
summary (ShopifyPaymentsPayoutSummary!)

The summary of the payout.
transactionType (ShopifyPaymentsPayoutTransactionType!)

The direction of the payout.

Types that return ShopifyPaymentsPayout

Implements

Deprecated fields

Show/Hide
gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead

Sign up for a Partner account to get started.

Sign up