Choose a version:

shopifyPaymentsAccount

query

Shopify Payments account information, including balances and payouts.

Anchor to Possible returnsPossible returns

Anchor to ShopifyPaymentsAccountShopifyPaymentsAccount •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.

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/2025-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 } } } }"
}'

Remix

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();

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/2025-07/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 } } } } }"
}'

Remix

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

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/2025-07/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 } } } }"
}'

Remix

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

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/2025-07/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 } } } }"
}'

Remix

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

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/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopifyPaymentsShowBalance { shopifyPaymentsAccount { balance { amount currencyCode } } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query ShopifyPaymentsShowBalance {
    shopifyPaymentsAccount {
      balance {
        amount
        currencyCode
      }
    }
  }`,
);

const data = await response.json();

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

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/2025-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,

"adjustmentsOrders": [],

"adjustmentReason": null

{

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

"type": "TRANSFER",

"test": false,

"associatedPayout": {

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

"status": "FAILED"