Choose a version:

ShopifyPaymentsAccount

object

Requires the read_shopify_payments or the read_shopify_payments_accounts 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.

Anchor to Fields and connectionsFields and connections

Anchor to activatedactivated • Boolean!non-null: Whether the Shopify Payments setup is completed.
Anchor to balancebalance • [MoneyV2!]!non-null: Current balances in all currencies for the account.
Anchor to balanceTransactionsbalanceTransactions • ShopifyPaymentsBalanceTransactionConnection!non-null: A list of balance transactions associated with the shop.
Anchor to bankAccountsbankAccounts • ShopifyPaymentsBankAccountConnection!non-null: All bank accounts configured for the Shopify Payments account.
Anchor to chargeStatementDescriptorschargeStatementDescriptors • ShopifyPaymentsChargeStatementDescriptor: The statement descriptors used for charges.

These descriptors appear on a customer's credit card or bank statement when they make a purchase.
Anchor to countrycountry • String!non-null: The Shopify Payments account country.
Anchor to defaultCurrencydefaultCurrency • CurrencyCode!non-null: The default payout currency for the Shopify Payments account.
Anchor to disputesdisputes • ShopifyPaymentsDisputeConnection!non-null: All disputes that originated from a transaction made with the Shopify Payments account.
Anchor to fraudSettingsfraudSettings • ShopifyPaymentsFraudSettings!non-null: The fraud settings of the Shopify Payments account.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to notificationSettingsnotificationSettings • ShopifyPaymentsNotificationSettings!non-null: The notifications settings for the account.
Anchor to onboardableonboardable • Boolean!non-null: Whether the Shopify Payments account can be onboarded.
Anchor to payoutspayouts • ShopifyPaymentsPayoutConnection!non-null: All current and previous payouts made between the account and the bank account.
Anchor to payoutSchedulepayoutSchedule • ShopifyPaymentsPayoutSchedule!non-null: The payout schedule for the account.
Anchor to payoutStatementDescriptorpayoutStatementDescriptor • String: The descriptor used for payouts.

The descriptor appears on a merchant's bank statement when they receive a payout.
Anchor to permittedVerificationDocumentspermittedVerificationDocuments • [ShopifyPaymentsVerificationDocument!]!non-null: The permitted documents for identity verification.
Anchor to verificationsverifications • [ShopifyPaymentsVerification!]!non-null: The verifications necessary for this account.
Anchor to chargeStatementDescriptorchargeStatementDescriptor • StringDeprecated: The statement descriptor used for charges.

The statement descriptor appears on a customer's credit card or bank statement when they make a purchase. Use chargeStatementDescriptors instead.

Was this section helpful?

Anchor to QueriesQueries

Anchor to shopifyPaymentsAccount shopifyPaymentsAccount • query: Shopify Payments account information, including balances and payouts.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node • interface

Was this section helpful?