ShopifyPaymentsPayout object
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return ShopifyPaymentsPayout
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayout
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.
Types that return ShopifyPaymentsPayoutEdge
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!
) deprecatedThe total amount and currency of the payout.
Deprecation warning
Use
net
instead
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.
On this page
Fields
-
edges (
[ShopifyPaymentsPayoutEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ShopifyPaymentsPayout!
)The item at the end of ShopifyPaymentsPayoutEdge.