Export Balance Transactions from Shopify
This task will export a list of balance transactions from Shopify Payments, and save them to an XML file. Balance transactions provide a more detailed breakdown of the individual transactions that make up a payout, at an individual order level.
Note
This task will only work if you are using Shopify Payments as the payment gateway for your store, and you have enabled the 'read_shopify_payments' or 'read_shopify_payments_accounts' scope within the private app you created as part of the connection setup process.
Settings
Shopify Connection
Required
The Shopify connection to use. See Shopify Connection if you require more information on how to create/manage connections.
Currency Code
Optional
Used to filter the balance transactions that will be exported by the task, based on currency code. For example GBP
.
Export Settings
-
Since ID
Used when exporting new records. Only records where the ID is higher than this value will be exported. The ID will update automatically each time the task runs. -
Export Modified or All Records
Select whether you would like the task to export modified or all records from Shopify.
Export Transfers
Required
Set to true
to include transactions of type transfer in the export from Shopify. These transactions represent the payment of a payout.
Page Size
Required
Used to control the number of records that are requested from Shopify at a time. Defaults to 100
.
Payment Method Name
Optional
Used to filter the balance transactions that will be exported by the task, based on payment method name.
Payment Status
Required
Used to filter the balance transactions that will be exported by the task, based on payment status. Set to ANY
to export balance transactions regardless of their payment status, or choose a specific status to export:-
- ACTION_REQUIRED
- CANCELLED
- FAILED
- PAID
- PENDING
- SCHEDULED
Record IDs
Optional
To export specific records from Shopify, enter an ID or comma separated list of IDs. The IDs can be either be specified in integer or global ID format. Examples are shown below:
- Integer Format -
96382004,96382006
- Global ID Format -
gid://shopify/{object_name}/96382004,gid://shopify/{object_name}/96382006
where{object_name}
is replaced with the name of the object, e.g.Customer
. More information can be found here.
This will override all other export settings.
Selections
Required
The set of fields to select from Shopify. For more details about the syntax, please refer to Selections Syntax.
For more details about the Shopify payments balance transfer object and it's fields, please refer to Shopify's documentation.
Timeout
Optional
The length of time to wait (in seconds) for Shopify to respond to each API request. If left blank, or set to 0 or less, a default value of 100 seconds will be applied.
Transaction Type
Required
Used to filter the balance transactions that will be exported by the task, based on transaction type. Set to ANY
to export balance transactions regardless of their transaction type, or choose a specific status to export.
Zynk Settings
Permissions
This task requires the following permissions in your Shopify app:
read_shopify_payments
orread_shopify_payments_accounts
Examples
A sample output file is shown below. The fields returned will vary depending on your selections.
<?xml version="1.0" encoding="utf-8"?>
<ShopifyPaymentsBalanceTransactions>
<ShopifyPaymentsBalanceTransaction>
<Id>gid://shopify/ShopifyPaymentsBalanceTransaction/1892022448452</Id>
<AdjustmentsOrders />
<Amount>
<Amount>81.03</Amount>
<CurrencyCode>GBP</CurrencyCode>
</Amount>
<AssociatedOrder>
<Id>gid://shopify/Order/10119531671876</Id>
</AssociatedOrder>
<AssociatedPayout>
<Id>gid://shopify/ShopifyPaymentsPayout/40764643652</Id>
<Status>PAID</Status>
</AssociatedPayout>
<Fee>
<Amount>3.0</Amount>
</Fee>
<Net>
<Amount>78.03</Amount>
</Net>
<SourceId>2279872393540</SourceId>
<SourceOrderTransactionId>10404208013636</SourceOrderTransactionId>
<SourceType>CHARGE</SourceType>
<Test>false</Test>
<TransactionDate>2025-09-23T15:48:58Z</TransactionDate>
<Type>CHARGE</Type>
</ShopifyPaymentsBalanceTransaction>
<ShopifyPaymentsBalanceTransaction>
<Id>gid://shopify/ShopifyPaymentsBalanceTransaction/1892162335044</Id>
<AdjustmentsOrders />
<Amount>
<Amount>56.43</Amount>
<CurrencyCode>GBP</CurrencyCode>
</Amount>
<AssociatedOrder>
<Id>gid://shopify/Order/10119832547652</Id>
</AssociatedOrder>
<AssociatedPayout>
<Id>gid://shopify/ShopifyPaymentsPayout/40764643652</Id>
<Status>PAID</Status>
</AssociatedPayout>
<Fee>
<Amount>1.49</Amount>
</Fee>
<Net>
<Amount>54.94</Amount>
</Net>
<SourceId>2280052126020</SourceId>
<SourceOrderTransactionId>10404589171012</SourceOrderTransactionId>
<SourceType>CHARGE</SourceType>
<Test>false</Test>
<TransactionDate>2025-09-23T19:16:11Z</TransactionDate>
<Type>CHARGE</Type>
</ShopifyPaymentsBalanceTransaction>
<ShopifyPaymentsBalanceTransaction>
<Id>gid://shopify/ShopifyPaymentsBalanceTransaction/1893122863428</Id>
<AdjustmentsOrders />
<Amount>
<Amount>-132.97</Amount>
<CurrencyCode>GBP</CurrencyCode>
</Amount>
<AssociatedPayout>
<Id>gid://shopify/ShopifyPaymentsPayout/40764643652</Id>
<Status>PAID</Status>
</AssociatedPayout>
<Fee>
<Amount>0.0</Amount>
</Fee>
<Net>
<Amount>-132.97</Amount>
</Net>
<SourceId>40764643652</SourceId>
<SourceType>TRANSFER</SourceType>
<Test>false</Test>
<TransactionDate>2025-09-25T00:05:11Z</TransactionDate>
<Type>TRANSFER</Type>
</ShopifyPaymentsBalanceTransaction>
</ShopifyPaymentsBalanceTransactions>