ShopifyPaymentsPayout object
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 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
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 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
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 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
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 warningUse |