Anchor to shopifyPaymentsAccountshopify
shopifyPaymentsAccount
query
Shopify Payments account information, including balances and payouts.
Anchor to Possible returnsPossible returns
- Anchor to ShopifyPaymentsAccountShopify•
Payments Account 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?
- 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
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 {
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-04/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,