Skip to main content
Anchor to ShopifyPaymentsPayout

ShopifyPaymentsPayout

object

Requires The user must have the view_payouts permission.

A transfer of funds between a merchant's Shopify Payments balance and their ShopifyPaymentsBankAccount. Provides the net amount, issue date, and current ShopifyPaymentsPayoutStatus.

The payout includes a ShopifyPaymentsPayoutSummary that breaks down fees and gross amounts by transaction type, such as charges, refunds, and adjustments. The ShopifyPaymentsPayoutTransactionType indicates whether funds move into the bank account (deposit) or back to Shopify Payments (withdrawal).

•BusinessEntity!
non-null

The business entity associated with the payout.

Show fields
•ShopifyPaymentsDestinationAccount

The destination account for the payout.

Show fields
•String

A unique trace ID from the financial institution. Use this reference number to track the payout with your provider.

•ID!
non-null

A globally-unique ID.

•DateTime!
non-null

The exact time when the payout was issued. The payout only contains balance transactions that were available at this time.

•UnsignedInt64!
non-null

The ID of the corresponding resource in the REST Admin API.

•MoneyV2!
non-null

The total amount and currency of the payout.

Show fields
•ShopifyPaymentsPayoutStatus!
non-null

The transfer status of the payout.

Show enum values
•ShopifyPaymentsPayoutSummary!
non-null

The summary of the payout.

Show fields
•ShopifyPaymentsPayoutTransactionType!
non-null

The direction of the payout.

Show enum values

Deprecated fields

•ShopifyPaymentsBankAccount
Deprecated
Show fields
•MoneyV2!
non-nullDeprecated
Show fields

Was this section helpful?

•interface

Was this section helpful?