stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > ShopifyPaymentsAccount

AdminTypes.ShopifyPaymentsAccount interface

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.

Signature:

export interface ShopifyPaymentsAccount extends Node 

Extends: Node

Properties

Property Modifiers Type Description
activated   Scalars[‘Boolean’][‘output’] Whether the Shopify Payments setup is completed.
balance   Array<MoneyV2> Current balances in all currencies for the account.
bankAccounts   ShopifyPaymentsBankAccountConnection All bank accounts configured for the Shopify Payments account.
chargeStatementDescriptor?   Maybe<Scalars[‘String’][‘output’]> <p>(Optional) The statement descriptor used for charges.</p><p>The statement descriptor appears on a customer’s credit card or bank statement when they make a purchase.</p>
chargeStatementDescriptors?   Maybe<ShopifyPaymentsChargeStatementDescriptor> <p>(Optional) The statement descriptors used for charges.</p><p>These descriptors appear on a customer’s credit card or bank statement when they make a purchase.</p>
country   Scalars[‘String’][‘output’] The Shopify Payments account country.
defaultCurrency   CurrencyCode | `${CurrencyCode}` The default payout currency for the Shopify Payments account.
disputes   ShopifyPaymentsDisputeConnection All disputes related to the Shopify Payments account.
fraudSettings   ShopifyPaymentsFraudSettings The fraud settings of the Shopify Payments account.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
notificationSettings   ShopifyPaymentsNotificationSettings The notifications settings for the account.
onboardable   Scalars[‘Boolean’][‘output’] Whether the Shopify Payments account can be onboarded.
payouts   ShopifyPaymentsPayoutConnection All current and previous payouts made between the account and the bank account.
payoutSchedule   ShopifyPaymentsPayoutSchedule The payout schedule for the account.
payoutStatementDescriptor?   Maybe<Scalars[‘String’][‘output’]> <p>(Optional) The descriptor used for payouts.</p><p>The descriptor appears on a merchant’s bank statement when they receive a payout.</p>
permittedVerificationDocuments   Array<ShopifyPaymentsVerificationDocument> The permitted documents for identity verification.
verifications   Array<ShopifyPaymentsVerification> The verifications necessary for this account.