ShopifyPaymentsPayout
Payouts represent the movement of money between a merchant's Shopify Payments balance and their bank account.
Required access
read_shopify_payments access scope
"""
Payouts represent the movement of money between a merchant's Shopify
Payments balance and their bank account.
"""
type ShopifyPaymentsPayout implements LegacyInteroperability & Node {
"""
The bank account for the payout.
"""
bankAccount: ShopifyPaymentsBankAccount!
"""
The total amount and currency of the payout.
"""
gross: MoneyV2!
"""
Globally unique identifier.
"""
id: ID!
"""
The exact time when the payout was issued. The payout only contains
balance transactions that were available at this time.
"""
issuedAt: DateTime!
"""
The ID of the corresponding resource in the REST Admin API.
"""
legacyResourceId: UnsignedInt64!
"""
The total amount and currency of the payout.
"""
net: MoneyV2!
"""
The transfer status of the payout.
"""
status: ShopifyPaymentsPayoutStatus!
"""
The summary of the payout.
"""
summary: ShopifyPaymentsPayoutSummary!
"""
The direction of the payout.
"""
transactionType: ShopifyPaymentsPayoutTransactionType!
}
Implements
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. |
Deprecated fields
Show/Hide
gross
(MoneyV2!)
deprecated
|
The total amount and currency of the payout. Deprecation warningUse |
Payouts represent the movement of money between a merchant's Shopify Payments balance and their bank account.
Required access
read_shopify_payments access scope
"""
Payouts represent the movement of money between a merchant's Shopify
Payments balance and their bank account.
"""
type ShopifyPaymentsPayout implements LegacyInteroperability & Node {
"""
The bank account for the payout.
"""
bankAccount: ShopifyPaymentsBankAccount!
"""
The total amount and currency of the payout.
"""
gross: MoneyV2!
"""
Globally unique identifier.
"""
id: ID!
"""
The exact time when the payout was issued. The payout only contains
balance transactions that were available at this time.
"""
issuedAt: DateTime!
"""
The ID of the corresponding resource in the REST Admin API.
"""
legacyResourceId: UnsignedInt64!
"""
The total amount and currency of the payout.
"""
net: MoneyV2!
"""
The transfer status of the payout.
"""
status: ShopifyPaymentsPayoutStatus!
"""
The summary of the payout.
"""
summary: ShopifyPaymentsPayoutSummary!
"""
The direction of the payout.
"""
transactionType: ShopifyPaymentsPayoutTransactionType!
}
Implements
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. |
Deprecated fields
Show/Hide
gross
(MoneyV2!)
deprecated
|
The total amount and currency of the payout. Deprecation warningUse |
Payouts represent the movement of money between a merchant's Shopify Payments balance and their bank account.
Required access
read_shopify_payments access scope
"""
Payouts represent the movement of money between a merchant's Shopify
Payments balance and their bank account.
"""
type ShopifyPaymentsPayout implements LegacyInteroperability & Node {
"""
The bank account for the payout.
"""
bankAccount: ShopifyPaymentsBankAccount!
"""
The total amount and currency of the payout.
"""
gross: MoneyV2!
"""
Globally unique identifier.
"""
id: ID!
"""
The exact time when the payout was issued. The payout only contains
balance transactions that were available at this time.
"""
issuedAt: DateTime!
"""
The ID of the corresponding resource in the REST Admin API.
"""
legacyResourceId: UnsignedInt64!
"""
The total amount and currency of the payout.
"""
net: MoneyV2!
"""
The transfer status of the payout.
"""
status: ShopifyPaymentsPayoutStatus!
"""
The summary of the payout.
"""
summary: ShopifyPaymentsPayoutSummary!
"""
The direction of the payout.
"""
transactionType: ShopifyPaymentsPayoutTransactionType!
}
Implements
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. |
Deprecated fields
Show/Hide
gross
(MoneyV2!)
deprecated
|
The total amount and currency of the payout. Deprecation warningUse |