ShopifyPaymentsPayout object

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

Required access

User must have given access.

On this page

Fields

  • bankAccount ([ShopifyPaymentsBankAccount!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentsbankaccount))
    The bank account for the payout.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • issuedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The exact time when the payout was issued. The payout only contains balance transactions that were available at this time.
  • legacyResourceId ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
    The ID of the corresponding resource in the REST Admin API.
  • net ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    The total amount and currency of the payout.
  • status ([ShopifyPaymentsPayoutStatus!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentspayoutstatus))
    The transfer status of the payout.
  • summary ([ShopifyPaymentsPayoutSummary!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentspayoutsummary))
    The summary of the payout.
  • transactionType ([ShopifyPaymentsPayoutTransactionType!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentspayouttransactiontype))
    The direction of the payout.

Types that return ShopifyPaymentsPayout

  • [ShopifyPaymentsAccount.payouts](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentsaccount#payouts-2021-01)
  • [ShopifyPaymentsBankAccount.payouts](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentsbankaccount#payouts-2021-01)

Implements

  • [LegacyInteroperability](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/legacyinteroperability)
  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

Show/Hide

An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.

On this page

Fields

  • edges ([[ShopifyPaymentsPayoutEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentspayout))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([ShopifyPaymentsPayout!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentspayout))
    The item at the end of ShopifyPaymentsPayoutEdge.

Types that return ShopifyPaymentsPayoutEdge

  • [ShopifyPaymentsPayoutConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentspayout#edges-2021-01)