Shopify
Requires the or the 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•[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 bankAccountsbank•Shopify
Accounts Payments Bank Account Connection!non-null All bank accounts configured for the Shopify Payments account.
- 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 fraudSettingsfraud•Shopify
Settings Payments Fraud Settings!non-null The fraud settings of the Shopify Payments account.
- •ID!non-null
A globally-unique ID.
- Anchor to notificationSettingsnotification•Shopify
Settings Payments Notification Settings!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•Shopify
Payments Payout Connection!non-null All current and previous payouts made between the account and the bank account.
- 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 permittedVerificationDocumentspermitted•[Shopify
Verification Documents Payments Verification Document!]!non-null The permitted documents for identity verification.
- Anchor to verificationsverifications•[Shopify
Payments Verification!]!non-null The verifications necessary for this account.
- Anchor to chargeStatementDescriptorcharge•StringDeprecated
Statement Descriptor
Anchor to QueriesQueries
- •query
Shopify Payments account information, including balances and payouts.