Choose a version:

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 ShopifyPaymentsBalanceTransaction records showing charges, refunds, and adjustments that affect your balance. Also includes ShopifyPaymentsDispute records and ShopifyPaymentsPayout history between the account and connected ShopifyPaymentsBankAccount configurations.

Anchor to Possible returnsPossible returns

Anchor to ShopifyPaymentsAccountShopifyPaymentsAccount

•ShopifyPaymentsAccount

Financial account information for merchants using Shopify Payments. Tracks current balances across all supported currencies, payout schedules, and ShopifyPaymentsBalanceTransaction records.

The account includes configuration details such as ShopifyPaymentsBankAccount objects for receiving ShopifyPaymentsPayout transfers, statement descriptors that appear on customer credit card statements, and the ShopifyPaymentsPayoutSchedule 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 accountOpenerNameaccountOpenerName

•String

The name of the account opener.

Anchor to activatedactivated

•Boolean!

non-null

Whether the Shopify Payments setup is completed.

Anchor to balancebalance

•[MoneyV2!]!

non-null

Current balances in all currencies for the account.

Anchor to balanceTransactionsbalanceTransactions

•ShopifyPaymentsBalanceTransactionConnection!

non-null

A list of balance transactions associated with the shop.

Arguments

Anchor to hideTransfershideTransfers

•Boolean

Default:false

Determines if returned transactions contain transaction type transfer.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•BalanceTransactionSortKeys

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.

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 default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to available_on •time
Anchor to credit_card_last4 •string
Anchor to currency •string
Anchor to id •id: Filter by id range.
Anchor to payment_method_name •string
Anchor to payments_transfer_id •id
Anchor to payout_date •time
Anchor to payout_status •string
Anchor to processed_at •time
Anchor to tax_reporting_exempt •boolean
Anchor to transaction_type •string

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to bankAccountsbankAccounts

•ShopifyPaymentsBankAccountConnection!

non-null

All bank accounts configured for the Shopify Payments account.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to chargeStatementDescriptorschargeStatementDescriptors

•ShopifyPaymentsChargeStatementDescriptor

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 defaultCurrencydefaultCurrency

•CurrencyCode!

non-null

The default payout currency for the Shopify Payments account.

Anchor to disputesdisputes

•ShopifyPaymentsDisputeConnection!

non-null

All disputes that originated from a transaction made with the Shopify Payments account.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying 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 id •id: Filter by id range.
Anchor to initiated_at •time
Anchor to status •string

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to onboardableonboardable

•Boolean!

non-null

Whether the Shopify Payments account can be onboarded.

Anchor to payoutspayouts

•ShopifyPaymentsPayoutConnection!

non-null

All current and previous payouts made between the account and the bank account.

Arguments

Anchor to transactionTypetransactionType

•ShopifyPaymentsPayoutTransactionType

Filter the direction of the payout.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•PayoutSortKeys

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 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 default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to amount •float
Anchor to bank_account •string
Anchor to currency •string
Anchor to id •id: Filter by id range.
Anchor to issued_at •time
Anchor to ledger_type •string
Anchor to status •string
Anchor to transaction_dates •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to payoutSchedulepayoutSchedule

•ShopifyPaymentsPayoutSchedule!

non-null

The payout schedule for the account.

Anchor to payoutStatementDescriptorpayoutStatementDescriptor

•String

The descriptor used for payouts.

The descriptor appears on a merchant's bank statement when they receive a payout.

Anchor to chargeStatementDescriptorchargeStatementDescriptor

•String

Deprecated

Was this section helpful?

Examples

Return a list of all balance transactions

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
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/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 } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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
        }
      }
    }
  }`,
});

Response

{
  "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,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/374523424",
          "type": "TRANSFER",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/917000993",
            "status": "FAILED"
          },
          "amount": {
            "amount": "-41.9",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "-41.9"
          },
          "sourceId": "917000993",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/631321250",
          "type": "TRANSFER",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/631321250",
            "status": "SCHEDULED"
          },
          "amount": {
            "amount": "-41.9",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "-41.9"
          },
          "sourceId": "631321250",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/725076685",
          "type": "TRANSFER",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/725076685",
            "status": "PAID"
          },
          "amount": {
            "amount": "-41.9",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "-41.9"
          },
          "sourceId": "725076685",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/854848137",
          "type": "TRANSFER",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/623721858",
            "status": "PAID"
          },
          "amount": {
            "amount": "-41.9",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "-41.9"
          },
          "sourceId": "623721858",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/867808544",
          "type": "TRANSFER",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/867808544",
            "status": "PAID"
          },
          "amount": {
            "amount": "-41.9",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "-41.9"
          },
          "sourceId": "867808544",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/714327683",
          "type": "TRANSFER_FAILURE",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
            "status": "FAILED"
          },
          "amount": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "41.9"
          },
          "sourceId": "714327683",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/615671547",
          "type": "TRANSFER_FAILURE",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
            "status": "FAILED"
          },
          "amount": {
            "amount": "11.0",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "1.0"
          },
          "net": {
            "amount": "10.0"
          },
          "sourceId": null,
          "sourceType": null,
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/965204187",
          "type": "TRANSFER",
          "test": false,
          "associatedPayout": {
            "id": "gid://shopify/ShopifyPaymentsPayout/39438702",
            "status": "IN_TRANSIT"
          },
          "amount": {
            "amount": "-43.12",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "-43.12"
          },
          "sourceId": "39438702",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        },
        {
          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/922259259",
          "type": "TRANSFER_FAILURE",
          "test": false,
          "associatedPayout": {
            "id": null,
            "status": "PENDING"
          },
          "amount": {
            "amount": "43.12",
            "currencyCode": "USD"
          },
          "fee": {
            "amount": "0.0"
          },
          "net": {
            "amount": "43.12"
          },
          "sourceId": "512467833",
          "sourceType": "TRANSFER",
          "sourceOrderTransactionId": null,
          "associatedOrder": null,
          "adjustmentsOrders": [],
          "adjustmentReason": null
        }
      ]
    }
  }
}

Return a list of all disputes

Query

query ShopifyPaymentsListDisputes {
  shopifyPaymentsAccount {
    disputes(first: 10) {
      edges {
        node {
          amount {
            amount
            currencyCode
          }
          evidenceDueBy
          evidenceSentOn
          finalizedOn
          id
          initiatedAt
          reasonDetails {
            reason
            networkReasonCode
          }
          status
          type
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopifyPaymentsListDisputes { shopifyPaymentsAccount { disputes(first: 10) { edges { node { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query ShopifyPaymentsListDisputes {
    shopifyPaymentsAccount {
      disputes(first: 10) {
        edges {
          node {
            amount {
              amount
              currencyCode
            }
            evidenceDueBy
            evidenceSentOn
            finalizedOn
            id
            initiatedAt
            reasonDetails {
              reason
              networkReasonCode
            }
            status
            type
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 ShopifyPaymentsListDisputes {
    shopifyPaymentsAccount {
      disputes(first: 10) {
        edges {
          node {
            amount {
              amount
              currencyCode
            }
            evidenceDueBy
            evidenceSentOn
            finalizedOn
            id
            initiatedAt
            reasonDetails {
              reason
              networkReasonCode
            }
            status
            type
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query ShopifyPaymentsListDisputes {
    shopifyPaymentsAccount {
      disputes(first: 10) {
        edges {
          node {
            amount {
              amount
              currencyCode
            }
            evidenceDueBy
            evidenceSentOn
            finalizedOn
            id
            initiatedAt
            reasonDetails {
              reason
              networkReasonCode
            }
            status
            type
          }
        }
      }
    }
  }`,
});

Response

{
  "shopifyPaymentsAccount": {
    "disputes": {
      "edges": [
        {
          "node": {
            "amount": {
              "amount": "100.0",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2013-07-03T19:00:00-04:00",
            "evidenceSentOn": "2013-07-04T07:00:00-04:00",
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/1052608616",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "WON",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2024-11-20T19:00:00-05:00",
            "evidenceSentOn": null,
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/815713555",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "CREDIT_NOT_PROCESSED",
              "networkReasonCode": "4827"
            },
            "status": "NEEDS_RESPONSE",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2013-07-03T19:00:00-04:00",
            "evidenceSentOn": "2013-07-04T07:00:00-04:00",
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/782360659",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "WON",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "evidenceDueBy": null,
            "evidenceSentOn": null,
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/670893524",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "NEEDS_RESPONSE",
            "type": "INQUIRY"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2024-11-20T19:00:00-05:00",
            "evidenceSentOn": null,
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/598735659",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "NEEDS_RESPONSE",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "100.0",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2024-11-20T19:00:00-05:00",
            "evidenceSentOn": null,
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/297752803",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "LOST",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2024-11-20T19:00:00-05:00",
            "evidenceSentOn": null,
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/257169523",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "NEEDS_RESPONSE",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2024-11-20T19:00:00-05:00",
            "evidenceSentOn": "2024-11-07T19:00:00-05:00",
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/85190714",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "UNDER_REVIEW",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "100.0",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2024-11-20T19:00:00-05:00",
            "evidenceSentOn": null,
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/46484353",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "FRAUDULENT",
              "networkReasonCode": "4827"
            },
            "status": "LOST",
            "type": "CHARGEBACK"
          }
        },
        {
          "node": {
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "evidenceDueBy": "2024-11-20T19:00:00-05:00",
            "evidenceSentOn": null,
            "finalizedOn": null,
            "id": "gid://shopify/ShopifyPaymentsDispute/35982383",
            "initiatedAt": "2013-05-04T00:00:00Z",
            "reasonDetails": {
              "reason": "SUBSCRIPTION_CANCELLED",
              "networkReasonCode": "4827"
            },
            "status": "NEEDS_RESPONSE",
            "type": "CHARGEBACK"
          }
        }
      ]
    }
  }
}

Return a list of all payouts

Query

query ShopifyPaymentsPayoutShow {
  shopifyPaymentsAccount {
    payouts(first: 10) {
      nodes {
        id
        issuedAt
        net {
          amount
          currencyCode
        }
        status
        transactionType
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopifyPaymentsPayoutShow { shopifyPaymentsAccount { payouts(first: 10) { nodes { id issuedAt net { amount currencyCode } status transactionType } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query ShopifyPaymentsPayoutShow {
    shopifyPaymentsAccount {
      payouts(first: 10) {
        nodes {
          id
          issuedAt
          net {
            amount
            currencyCode
          }
          status
          transactionType
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 ShopifyPaymentsPayoutShow {
    shopifyPaymentsAccount {
      payouts(first: 10) {
        nodes {
          id
          issuedAt
          net {
            amount
            currencyCode
          }
          status
          transactionType
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query ShopifyPaymentsPayoutShow {
    shopifyPaymentsAccount {
      payouts(first: 10) {
        nodes {
          id
          issuedAt
          net {
            amount
            currencyCode
          }
          status
          transactionType
        }
      }
    }
  }`,
});

Response

{
  "shopifyPaymentsAccount": {
    "payouts": {
      "nodes": [
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/623721858",
          "issuedAt": "2012-11-12T00:00:00Z",
          "net": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "status": "PAID",
          "transactionType": "DEPOSIT"
        },
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/631321250",
          "issuedAt": "2012-11-12T00:00:00Z",
          "net": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "status": "SCHEDULED",
          "transactionType": "DEPOSIT"
        },
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
          "issuedAt": "2012-11-12T00:00:00Z",
          "net": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "status": "FAILED",
          "transactionType": "DEPOSIT"
        },
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/725076685",
          "issuedAt": "2012-11-12T00:00:00Z",
          "net": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "status": "PAID",
          "transactionType": "DEPOSIT"
        },
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/867808544",
          "issuedAt": "2012-11-12T00:00:00Z",
          "net": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "status": "PAID",
          "transactionType": "DEPOSIT"
        },
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/917000993",
          "issuedAt": "2012-11-13T00:00:00Z",
          "net": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "status": "FAILED",
          "transactionType": "DEPOSIT"
        },
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/39438702",
          "issuedAt": "2013-11-01T00:00:00Z",
          "net": {
            "amount": "43.12",
            "currencyCode": "USD"
          },
          "status": "SCHEDULED",
          "transactionType": "DEPOSIT"
        },
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/512467833",
          "issuedAt": "2013-12-01T00:00:00Z",
          "net": {
            "amount": "43.12",
            "currencyCode": "USD"
          },
          "status": "FAILED",
          "transactionType": "DEPOSIT"
        }
      ]
    }
  }
}

Return a single payout

Query

query ShopifyPaymentsPayoutShow {
  shopifyPaymentsAccount {
    payouts(first: 10, query: "id:623721858") {
      nodes {
        id
        issuedAt
        net {
          amount
          currencyCode
        }
        status
        transactionType
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopifyPaymentsPayoutShow { shopifyPaymentsAccount { payouts(first: 10, query: \"id:623721858\") { nodes { id issuedAt net { amount currencyCode } status transactionType } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query ShopifyPaymentsPayoutShow {
    shopifyPaymentsAccount {
      payouts(first: 10, query: "id:623721858") {
        nodes {
          id
          issuedAt
          net {
            amount
            currencyCode
          }
          status
          transactionType
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 ShopifyPaymentsPayoutShow {
    shopifyPaymentsAccount {
      payouts(first: 10, query: "id:623721858") {
        nodes {
          id
          issuedAt
          net {
            amount
            currencyCode
          }
          status
          transactionType
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query ShopifyPaymentsPayoutShow {
    shopifyPaymentsAccount {
      payouts(first: 10, query: "id:623721858") {
        nodes {
          id
          issuedAt
          net {
            amount
            currencyCode
          }
          status
          transactionType
        }
      }
    }
  }`,
});

Response

{
  "shopifyPaymentsAccount": {
    "payouts": {
      "nodes": [
        {
          "id": "gid://shopify/ShopifyPaymentsPayout/623721858",
          "issuedAt": "2012-11-12T00:00:00Z",
          "net": {
            "amount": "41.9",
            "currencyCode": "USD"
          },
          "status": "PAID",
          "transactionType": "DEPOSIT"
        }
      ]
    }
  }
}

Return the current balance

Query

query ShopifyPaymentsShowBalance {
  shopifyPaymentsAccount {
    balance {
      amount
      currencyCode
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopifyPaymentsShowBalance { shopifyPaymentsAccount { balance { amount currencyCode } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query ShopifyPaymentsShowBalance {
    shopifyPaymentsAccount {
      balance {
        amount
        currencyCode
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 ShopifyPaymentsShowBalance {
    shopifyPaymentsAccount {
      balance {
        amount
        currencyCode
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query ShopifyPaymentsShowBalance {
    shopifyPaymentsAccount {
      balance {
        amount
        currencyCode
      }
    }
  }`,
});

Response

{
  "shopifyPaymentsAccount": {
    "balance": [
      {
        "amount": "0.0",
        "currencyCode": "USD"
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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 json = await response.json();

return json.data;

}

GQL

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/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 } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Node.js

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
        }
      }
    }
  }`,
});

Ruby

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,

"adjustmentsOrders": [],

"adjustmentReason": null

{

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

"type": "TRANSFER",

"test": false,

"associatedPayout": {

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

"status": "FAILED"