ShopifyPaymentsAccount

Also in this section

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 {
  # Whether the Shopify Payments setup is completed.
  activated: Boolean!

  # 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!

  # Statement descriptor used for charges.
  #
  # This is what buyers will see on their credit card or bank statements when making a purchase.
  chargeStatementDescriptor: String

  # Statement descriptors used for charges.
  #
  # This is what buyers will see on their credit card or bank statements when making a purchase.
  chargeStatementDescriptors: ShopifyPaymentsChargeStatementDescriptor

  # The Shopify Payments account country.
  country: String!

  # The default payout currency for the Shopify Payments account.
  defaultCurrency: CurrencyCode!

  # All disputes related to the Shopify Payments account.
  disputes(
    # 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

    # Supported filter parameters:
    #  - `id`
    #  - `initiated_at`
    #  - `status`
    #
    # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    query: String

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

  # The fraud settings of the Shopify Payments account.
  fraudSettings: ShopifyPaymentsFraudSettings!

  # Globally unique identifier.
  id: ID!

  # The notifications settings for the account.
  notificationSettings: ShopifyPaymentsNotificationSettings!

  # Payout schedule for the account.
  payoutSchedule: ShopifyPaymentsPayoutSchedule!

  # Descriptor used for payouts.
  #
  # This is what merchants will see on their bank statement when receiving a payout.
  payoutStatementDescriptor: String

  # 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!

  # The permitted documents for identity verification.
  permittedVerificationDocuments: [ShopifyPaymentsVerificationDocument!]!

  # The verifications necessary for this account.
  verifications: [ShopifyPaymentsVerification!]!
}

Implements

• Node

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.

disputes   (ShopifyPaymentsDisputeConnection!)

All disputes related to 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.
query	String		Supported filter parameters: id initiated_at status See the detailed search syntax.
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

activated   (Boolean!)

Whether the Shopify Payments setup is completed.

balance   ([MoneyV2!]!)

Current balances in all currencies for the account.

chargeStatementDescriptors   (ShopifyPaymentsChargeStatementDescriptor)

Statement descriptors used for charges.

This is what buyers will see on their credit card or bank statements when making a purchase.

country   (String!)

The Shopify Payments account country.

defaultCurrency   (CurrencyCode!)

The default payout currency for the Shopify Payments account.

fraudSettings   (ShopifyPaymentsFraudSettings!)

The fraud settings of the Shopify Payments account.

id   (ID!)

Globally unique identifier.

notificationSettings   (ShopifyPaymentsNotificationSettings!)

The notifications settings for the account.

payoutSchedule   (ShopifyPaymentsPayoutSchedule!)

Payout schedule for the account.

payoutStatementDescriptor   (String)

Descriptor used for payouts.

This is what merchants will see on their bank statement when receiving a payout.

permittedVerificationDocuments   ([ShopifyPaymentsVerificationDocument!]!)

The permitted documents for identity verification.

verifications   ([ShopifyPaymentsVerification!]!)

The verifications necessary for this account.

Deprecated fields

Show/Hide

chargeStatementDescriptor   (String)

deprecated

Statement descriptor used for charges.

This is what buyers will see on their credit card or bank statements when making a purchase.

Deprecation warning

Use chargeStatementDescriptors instead