stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > ShopifyPaymentsPayout

AdminTypes.ShopifyPaymentsPayout interface

Payouts represent the movement of money between a merchant’s Shopify Payments balance and their bank account.

Signature:

export interface ShopifyPaymentsPayout extends LegacyInteroperability, Node 

Extends: LegacyInteroperability, Node

Properties

Property Modifiers Type Description
bankAccount?   Maybe<ShopifyPaymentsBankAccount> (Optional) The bank account for the payout.
gross   MoneyV2 The total amount and currency of the payout.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
issuedAt   Scalars[‘DateTime’][‘output’] The exact time when the payout was issued. The payout only contains balance transactions that were available at this time.
legacyResourceId   Scalars[‘UnsignedInt64’][‘output’] The ID of the corresponding resource in the REST Admin API.
net   MoneyV2 The total amount and currency of the payout.
status   ShopifyPaymentsPayoutStatus | `${ShopifyPaymentsPayoutStatus}` The transfer status of the payout.
summary   ShopifyPaymentsPayoutSummary The summary of the payout.
transactionType   ShopifyPaymentsPayoutTransactionType | `${ShopifyPaymentsPayoutTransactionType}` The direction of the payout.