shopifyPaymentsAccount

Returns the Shopify Payments account information for the shop. Includes current balances across all currencies, payout schedules, and bank account configurations.

Use it in a workflow

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

query ShopifyPaymentsAccount {
  shopifyPaymentsAccount {
    accountOpenerName
    activated
    balance {
      amount
      currencyCode
    }
    chargeStatementDescriptor
    chargeStatementDescriptors {
      default
      prefix
    }
    country
    defaultCurrency
    id
    onboardable
    payoutSchedule {
      interval
      monthlyAnchor
      weeklyAnchor
    }
    payoutStatementDescriptor
  }
}

Response

Read the result with {{shopifypaymentsaccount.response.data.data.shopifyPaymentsAccount}}. If the API returns errors, the step fails and they are at {{shopifypaymentsaccount.response.data.errors}}.

Need more? See the Shopify guide for connection setup and behaviour shared by every action.