API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

ShopifyPaymentsPayout object

Version unstable

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version unstable

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.

Types that return ShopifyPaymentsPayout

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayout

Version 2021-01 (Release candidate)

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2021-01 (Release candidate)

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Version 2020-10 (Latest)

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2020-10 (Latest)

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-10 (Latest)

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Version 2020-07

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2020-07

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-07

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Version 2020-04

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2020-04

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-04

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Version 2020-01

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2020-01

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-01

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Version 2019-10 (Unsupported)

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2019-10 (Unsupported)

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2019-10 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Version 2019-07 (Unsupported)

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2019-07 (Unsupported)

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2019-07 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Version 2019-04 (Unsupported)

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

Required access

User must have given access.

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

gross (MoneyV2!) deprecated

The total amount and currency of the payout.

Deprecation warning

Use net instead
Version 2019-04 (Unsupported)

On this page

Fields

edges ([ShopifyPaymentsPayoutEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2019-04 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.
node (ShopifyPaymentsPayout!)

The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

Samples