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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    shopifyPaymentsAccount {
7      balanceTransactions(first: 10) {
8        nodes {
9          id
10          type
11          test
12          associatedPayout {
13            id
14            status
15          }
16          amount {
17            amount
18            currencyCode
19          }
20          fee {
21            amount
22          }
23          net {
24            amount
25          }
26          sourceId
27          sourceType
28          sourceOrderTransactionId
29          associatedOrder {
30            id
31          }
32          adjustmentsOrders {
33            orderTransactionId
34            amount {
35              amount
36            }
37            name
38          }
39          adjustmentReason
40        }
41      }
42    }
43  }`,
44);
45
46const data = await response.json();
47

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

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

1{
2  "shopifyPaymentsAccount": {
3    "balanceTransactions": {
4      "nodes": [
5        {
6          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/44598600",
7          "type": "TRANSFER",
8          "test": false,
9          "associatedPayout": {
10            "id": "gid://shopify/ShopifyPaymentsPayout/512467833",
11            "status": "FAILED"
12          },
13          "amount": {
14            "amount": "-41.9",
15            "currencyCode": "USD"
16          },
17          "fee": {
18            "amount": "0.0"
19          },
20          "net": {
21            "amount": "-41.9"
22          },
23          "sourceId": "512467833",
24          "sourceType": "TRANSFER",
25          "sourceOrderTransactionId": null,
26          "associatedOrder": null,
27          "adjustmentsOrders": [],
28          "adjustmentReason": null
29        },
30        {
31          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/374523424",
32          "type": "TRANSFER",
33          "test": false,
34          "associatedPayout": {
35            "id": "gid://shopify/ShopifyPaymentsPayout/917000993",
36            "status": "FAILED"
37          },
38          "amount": {
39            "amount": "-41.9",
40            "currencyCode": "USD"
41          },
42          "fee": {
43            "amount": "0.0"
44          },
45          "net": {
46            "amount": "-41.9"
47          },
48          "sourceId": "917000993",
49          "sourceType": "TRANSFER",
50          "sourceOrderTransactionId": null,
51          "associatedOrder": null,
52          "adjustmentsOrders": [],
53          "adjustmentReason": null
54        },
55        {
56          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/631321250",
57          "type": "TRANSFER",
58          "test": false,
59          "associatedPayout": {
60            "id": "gid://shopify/ShopifyPaymentsPayout/631321250",
61            "status": "SCHEDULED"
62          },
63          "amount": {
64            "amount": "-41.9",
65            "currencyCode": "USD"
66          },
67          "fee": {
68            "amount": "0.0"
69          },
70          "net": {
71            "amount": "-41.9"
72          },
73          "sourceId": "631321250",
74          "sourceType": "TRANSFER",
75          "sourceOrderTransactionId": null,
76          "associatedOrder": null,
77          "adjustmentsOrders": [],
78          "adjustmentReason": null
79        },
80        {
81          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/725076685",
82          "type": "TRANSFER",
83          "test": false,
84          "associatedPayout": {
85            "id": "gid://shopify/ShopifyPaymentsPayout/725076685",
86            "status": "PAID"
87          },
88          "amount": {
89            "amount": "-41.9",
90            "currencyCode": "USD"
91          },
92          "fee": {
93            "amount": "0.0"
94          },
95          "net": {
96            "amount": "-41.9"
97          },
98          "sourceId": "725076685",
99          "sourceType": "TRANSFER",
100          "sourceOrderTransactionId": null,
101          "associatedOrder": null,
102          "adjustmentsOrders": [],
103          "adjustmentReason": null
104        },
105        {
106          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/854848137",
107          "type": "TRANSFER",
108          "test": false,
109          "associatedPayout": {
110            "id": "gid://shopify/ShopifyPaymentsPayout/623721858",
111            "status": "PAID"
112          },
113          "amount": {
114            "amount": "-41.9",
115            "currencyCode": "USD"
116          },
117          "fee": {
118            "amount": "0.0"
119          },
120          "net": {
121            "amount": "-41.9"
122          },
123          "sourceId": "623721858",
124          "sourceType": "TRANSFER",
125          "sourceOrderTransactionId": null,
126          "associatedOrder": null,
127          "adjustmentsOrders": [],
128          "adjustmentReason": null
129        },
130        {
131          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/867808544",
132          "type": "TRANSFER",
133          "test": false,
134          "associatedPayout": {
135            "id": "gid://shopify/ShopifyPaymentsPayout/867808544",
136            "status": "PAID"
137          },
138          "amount": {
139            "amount": "-41.9",
140            "currencyCode": "USD"
141          },
142          "fee": {
143            "amount": "0.0"
144          },
145          "net": {
146            "amount": "-41.9"
147          },
148          "sourceId": "867808544",
149          "sourceType": "TRANSFER",
150          "sourceOrderTransactionId": null,
151          "associatedOrder": null,
152          "adjustmentsOrders": [],
153          "adjustmentReason": null
154        },
155        {
156          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/714327683",
157          "type": "TRANSFER_FAILURE",
158          "test": false,
159          "associatedPayout": {
160            "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
161            "status": "FAILED"
162          },
163          "amount": {
164            "amount": "41.9",
165            "currencyCode": "USD"
166          },
167          "fee": {
168            "amount": "0.0"
169          },
170          "net": {
171            "amount": "41.9"
172          },
173          "sourceId": "714327683",
174          "sourceType": "TRANSFER",
175          "sourceOrderTransactionId": null,
176          "associatedOrder": null,
177          "adjustmentsOrders": [],
178          "adjustmentReason": null
179        },
180        {
181          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/615671547",
182          "type": "TRANSFER_FAILURE",
183          "test": false,
184          "associatedPayout": {
185            "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
186            "status": "FAILED"
187          },
188          "amount": {
189            "amount": "11.0",
190            "currencyCode": "USD"
191          },
192          "fee": {
193            "amount": "1.0"
194          },
195          "net": {
196            "amount": "10.0"
197          },
198          "sourceId": null,
199          "sourceType": null,
200          "sourceOrderTransactionId": null,
201          "associatedOrder": null,
202          "adjustmentsOrders": [],
203          "adjustmentReason": null
204        },
205        {
206          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/965204187",
207          "type": "TRANSFER",
208          "test": false,
209          "associatedPayout": {
210            "id": "gid://shopify/ShopifyPaymentsPayout/39438702",
211            "status": "IN_TRANSIT"
212          },
213          "amount": {
214            "amount": "-43.12",
215            "currencyCode": "USD"
216          },
217          "fee": {
218            "amount": "0.0"
219          },
220          "net": {
221            "amount": "-43.12"
222          },
223          "sourceId": "39438702",
224          "sourceType": "TRANSFER",
225          "sourceOrderTransactionId": null,
226          "associatedOrder": null,
227          "adjustmentsOrders": [],
228          "adjustmentReason": null
229        },
230        {
231          "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/922259259",
232          "type": "TRANSFER_FAILURE",
233          "test": false,
234          "associatedPayout": {
235            "id": null,
236            "status": "PENDING"
237          },
238          "amount": {
239            "amount": "43.12",
240            "currencyCode": "USD"
241          },
242          "fee": {
243            "amount": "0.0"
244          },
245          "net": {
246            "amount": "43.12"
247          },
248          "sourceId": "512467833",
249          "sourceType": "TRANSFER",
250          "sourceOrderTransactionId": null,
251          "associatedOrder": null,
252          "adjustmentsOrders": [],
253          "adjustmentReason": null
254        }
255      ]
256    }
257  }
258}