ShopifyPaymentsAccount

Required access

read_shopify_payments access scope

Balance and payout information for a Shopify Payments account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field.

Show definition
# Balance and payout information for a
# [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments)
# account. Balance includes all balances for the currencies supported by the shop.
# You can also query for a list of payouts, where each payout includes the corresponding currencyCode field.
type ShopifyPaymentsAccount implements Node {
  # Current balances in all currencies for the account.
  balance: [MoneyV2!]!

  # All bank accounts configured for the Shopify Payments account.
  bankAccounts(
    # Returns the elements that come after the specified cursor.
    after: String

    # Returns the elements that come before the specified cursor.
    before: String

    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns up to the last `n` elements from the list.
    last: Int

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): ShopifyPaymentsBankAccountConnection!

  # Globally unique identifier.
  id: ID!

  # All current and previous payouts made between the account and the bank account.
  payouts(
    # Returns the elements that come after the specified cursor.
    after: String

    # Returns the elements that come before the specified cursor.
    before: String

    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns up to the last `n` elements from the list.
    last: Int

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Filter the direction of the payout.
    transactionType: ShopifyPaymentsPayoutTransactionType
  ): ShopifyPaymentsPayoutConnection!
}

Implements

Connections

bankAccounts   (ShopifyPaymentsBankAccountConnection!)

All bank accounts configured for the Shopify Payments account.

Argument Type Default Description
after

String

Returns the elements that come after the specified cursor.

before

String

Returns the elements that come before the specified cursor.

first

Int

Returns up to the first n elements from the list.

last

Int

Returns up to the last n elements from the list.

reverse

Boolean

false

Reverse the order of the underlying list.

payouts   (ShopifyPaymentsPayoutConnection!)

All current and previous payouts made between the account and the bank account.

Argument Type Default Description
after

String

Returns the elements that come after the specified cursor.

before

String

Returns the elements that come before the specified cursor.

first

Int

Returns up to the first n elements from the list.

last

Int

Returns up to the last n elements from the list.

reverse

Boolean

false

Reverse the order of the underlying list.

transactionType

ShopifyPaymentsPayoutTransactionType

Filter the direction of the payout.

Fields

balance   ([MoneyV2!]!)

Current balances in all currencies for the account.

id   (ID!)

Globally unique identifier.

Sign up for a Partner account to get started.

Sign up