Skip to main content
Anchor to ShopifyPaymentsPayout

ShopifyPaymentsPayout

object

Requires The user must have access to payouts.

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).

Anchor to FieldsFields

Anchor to businessEntitybusinessEntity
•BusinessEntity!
non-null

The business entity associated with the payout.

Anchor to destinationAccountdestinationAccount
•ShopifyPaymentsDestinationAccount

The destination account for the payout.

Anchor to externalTraceIdexternalTraceId
•String

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

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to issuedAtissuedAt
•DateTime!
non-null

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

Anchor to legacyResourceIdlegacyResourceId
•UnsignedInt64!
non-null

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

Anchor to netnet
•MoneyV2!
non-null

The total amount and currency of the payout.

Anchor to statusstatus
•ShopifyPaymentsPayoutStatus!
non-null

The transfer status of the payout.

Anchor to summarysummary
•ShopifyPaymentsPayoutSummary!
non-null

The summary of the payout.

Anchor to transactionTypetransactionType
•ShopifyPaymentsPayoutTransactionType!
non-null

The direction of the payout.

Deprecated fields

Anchor to bankAccountbankAccount
•ShopifyPaymentsBankAccount
Deprecated
Anchor to grossgross
•MoneyV2!
non-nullDeprecated
Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?