Shopify
Requires the or the access scope.
Financial account information for merchants using Shopify Payments. Tracks
current balances across all supported currencies, payout schedules, and records.
The account includes configuration details such as
objects for receiving
transfers, statement descriptors that appear on customer credit card statements, and the
that determines when funds transfer to your bank. Access balance transactions to
review individual charges, refunds, and adjustments that affect your account
balance. Query payouts to track money movement between your Shopify Payments
balance and bank accounts.
Anchor to FieldsFields
- accountOpenerName (String)
- activated (Boolean!)
- balance ([MoneyV2!]!)
- balanceTransactions (ShopifyPaymentsBalanceTransactionConnection!)
- bankAccounts (ShopifyPaymentsBankAccountConnection!)
- chargeStatementDescriptors (ShopifyPaymentsChargeStatementDescriptor)
- country (String!)
- defaultCurrency (CurrencyCode!)
- disputes (ShopifyPaymentsDisputeConnection!)
- id (ID!)
- onboardable (Boolean!)
- payouts (ShopifyPaymentsPayoutConnection!)
- payoutSchedule (ShopifyPaymentsPayoutSchedule!)
- payoutStatementDescriptor (String)
- chargeStatementDescriptor (String): deprecated
- Anchor to accountOpenerNameaccount•String
Opener Name The name of the account opener.
- Anchor to activatedactivated•Boolean!non-null
Whether the Shopify Payments setup is completed.
- Anchor to balancebalance•[Money
V2!]! non-null Current balances in all currencies for the account.
- Anchor to balanceTransactionsbalance•Shopify
Transactions Payments Balance Transaction Connection! non-null A list of balance transactions associated with the shop.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to hideTransfershide•Boolean
Transfers Default:false Determines if returned transactions contain transaction type transfer.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodieavailable_on time credit_card_last4 string currency string id id Filter by idrange.- id:1234
-id:>=1234
-id:<=1234payment_method_name string payments_transfer_id id payout_date time payout_status string processed_at time tax_reporting_exempt boolean transaction_type string You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). - Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to savedSearchIdsaved•ID
Search Id The ID of a saved search. The search’s query string is used as the query argument.
- Anchor to sortKeysort•Balance
Key Transaction Sort Keys Default:PROCESSED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to bankAccountsbank•Shopify
Accounts Payments Bank Account Connection! non-null All bank accounts configured for the Shopify Payments account.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to chargeStatementDescriptorscharge•Shopify
Statement Descriptors Payments Charge Statement Descriptor 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 defaultCurrencydefault•Currency
Currency Code! non-null The default payout currency for the Shopify Payments account.
- Anchor to disputesdisputes•Shopify
Payments Dispute Connection! non-null All disputes that originated from a transaction made with the Shopify Payments account.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •ID!non-null
A globally-unique ID.
- Anchor to onboardableonboardable•Boolean!non-null
Whether the Shopify Payments account can be onboarded.
- Anchor to payoutspayouts•Shopify
Payments Payout Connection! non-null All current and previous payouts made between the account and the bank account.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodieamount float bank_account string currency string id id Filter by idrange.- id:1234
-id:>=1234
-id:<=1234issued_at time ledger_type string status string transaction_dates time You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). - Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to savedSearchIdsaved•ID
Search Id The ID of a saved search. The search’s query string is used as the query argument.
- Anchor to sortKeysort•Payout
Key Sort Keys Default:ISSUED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to transactionTypetransaction•Shopify
Type Payments Payout Transaction Type Filter the direction of the payout.
Arguments
- Anchor to payoutSchedulepayout•Shopify
Schedule Payments Payout Schedule! non-null The payout schedule for the account.
- Anchor to payoutStatementDescriptorpayout•String
Statement Descriptor The descriptor used for payouts.
The descriptor appears on a merchant's bank statement when they receive a payout.
- Anchor to chargeStatementDescriptorcharge•String
Statement Descriptor Deprecated
Anchor to QueriesQueries
- shopifyPaymentsAccount (ShopifyPaymentsAccount)
- •query
Returns the Shopify Payments account information for the shop. Includes current balances across all currencies, payout schedules, and bank account configurations.
The account includes
records showing charges, refunds, and adjustments that affect your balance. Also includesrecords andhistory between the account and connectedconfigurations.