Choose a version:

shopifyPaymentsAccount

query

Shopify Payments account information, including balances and payouts.

Anchor to Possible returnsPossible returns

ShopifyPaymentsAccount

•

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.

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

These descriptors appear on a customer's credit card or bank statement when they make a purchase.
country• String! non-null: The Shopify Payments account country.
defaultCurrency• CurrencyCode! non-null: The default payout currency for the Shopify Payments account.
disputes • ShopifyPaymentsDisputeConnection! non-null: All disputes that originated from a transaction made with the Shopify Payments account.
fraudSettings• ShopifyPaymentsFraudSettings! non-null: The fraud settings of the Shopify Payments account.
id• ID! non-null: A globally-unique ID.
notificationSettings• ShopifyPaymentsNotificationSettings! non-null: The notifications settings for the account.
onboardable• Boolean! non-null: Whether the Shopify Payments account can be onboarded.
payouts • ShopifyPaymentsPayoutConnection! non-null: All current and previous payouts made between the account and the bank account.
payoutSchedule• ShopifyPaymentsPayoutSchedule! non-null: The payout schedule for the account.
payoutStatementDescriptor• String: The descriptor used for payouts.

The descriptor appears on a merchant's bank statement when they receive a payout.
permittedVerificationDocuments• [ShopifyPaymentsVerificationDocument!]! non-null: The permitted documents for identity verification.
verifications• [ShopifyPaymentsVerification!]! non-null: The verifications necessary for this account.
chargeStatementDescriptor• String Deprecated: 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?

Return a list of all balance transactions
Return a list of all disputes
Return a list of all payouts
Return a single payout
Return the current balance

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

shopifyPaymentsAccount {

balanceTransactions(first: 10) {

nodes {

type

test

associatedPayout {

status

}

amount {

amount

currencyCode

}

fee {

amount

}

net {

amount

}

sourceId

sourceType

sourceOrderTransactionId

associatedOrder {

}

adjustmentsOrders {

orderTransactionId

amount {

amount

}

name

}

adjustmentReason

}

}`,

);

const data = await response.json();

query {
  shopifyPaymentsAccount {
    balanceTransactions(first: 10) {
      nodes {
        id
        type
        test
        associatedPayout {
          id
          status
        }
        amount {
          amount
          currencyCode
        }
        fee {
          amount
        }
        net {
          amount
        }
        sourceId
        sourceType
        sourceOrderTransactionId
        associatedOrder {
          id
        }
        adjustmentsOrders {
          orderTransactionId
          amount {
            amount
          }
          name
        }
        adjustmentReason
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { shopifyPaymentsAccount { balanceTransactions(first: 10) { nodes { id type test associatedPayout { id status } amount { amount currencyCode } fee { amount } net { amount } sourceId sourceType sourceOrderTransactionId associatedOrder { id } adjustmentsOrders { orderTransactionId amount { amount } name } adjustmentReason } } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    shopifyPaymentsAccount {
      balanceTransactions(first: 10) {
        nodes {
          id
          type
          test
          associatedPayout {
            id
            status
          }
          amount {
            amount
            currencyCode
          }
          fee {
            amount
          }
          net {
            amount
          }
          sourceId
          sourceType
          sourceOrderTransactionId
          associatedOrder {
            id
          }
          adjustmentsOrders {
            orderTransactionId
            amount {
              amount
            }
            name
          }
          adjustmentReason
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    shopifyPaymentsAccount {
      balanceTransactions(first: 10) {
        nodes {
          id
          type
          test
          associatedPayout {
            id
            status
          }
          amount {
            amount
            currencyCode
          }
          fee {
            amount
          }
          net {
            amount
          }
          sourceId
          sourceType
          sourceOrderTransactionId
          associatedOrder {
            id
          }
          adjustmentsOrders {
            orderTransactionId
            amount {
              amount
            }
            name
          }
          adjustmentReason
        }
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    shopifyPaymentsAccount {
      balanceTransactions(first: 10) {
        nodes {
          id
          type
          test
          associatedPayout {
            id
            status
          }
          amount {
            amount
            currencyCode
          }
          fee {
            amount
          }
          net {
            amount
          }
          sourceId
          sourceType
          sourceOrderTransactionId
          associatedOrder {
            id
          }
          adjustmentsOrders {
            orderTransactionId
            amount {
              amount
            }
            name
          }
          adjustmentReason
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"shopifyPaymentsAccount": {

"balanceTransactions": {

"nodes": [

{

"id": "gid://shopify/ShopifyPaymentsBalanceTransaction/44598600",

"type": "TRANSFER",

"test": false,

"associatedPayout": {

"id": "gid://shopify/ShopifyPaymentsPayout/512467833",

"status": "FAILED"

"amount": {

"amount": "-41.9",

"currencyCode": "USD"

"fee": {

"amount": "0.0"

"net": {

"amount": "-41.9"

"sourceId": "512467833",

"sourceType": "TRANSFER",

"sourceOrderTransactionId": null,

"associatedOrder": null,