Skip to content

Export Payouts from Shopify

This task will export a list of payouts from Shopify Payments, and save them to an XML file.

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_payouts' 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.

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.

Page Size

Required
Used to control the number of records that are requested from Shopify at a time. Defaults to 100.

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 payout 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 payouts that will be exported by the task, based on the direction of the payout. The following options are available:

  • Any - Exports both deposits and withdrawals.
  • Deposit - Exports deposits only.
  • Withdrawal - Exports withdrawals only.

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.

Zynk Settings

See Common Task Settings

Permissions

This task requires the following permissions in your Shopify app:

  • read_shopify_payments_payouts

Examples

A sample output file is shown below. The fields returned will vary depending on your selections.

<?xml version="1.0" encoding="utf-8"?>
<ShopifyPaymentsPayouts xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ShopifyPaymentsPayout>
    <Id>gid://shopify/ShopifyPaymentsPayout/110422833476</Id>
    <BankAccount>
      <Id>gid://shopify/ShopifyPaymentsBankAccount/4654094660</Id>
      <AccountNumberLastDigits>15</AccountNumberLastDigits>
      <BankName>BANK OF IRELAND</BankName>
    </BankAccount>
    <IssuedAt>2025-01-21T00:00:00Z</IssuedAt>
    <Net>
      <Amount>27.51</Amount>
      <CurrencyCode>EUR</CurrencyCode>
    </Net>
    <Status>PAID</Status>
    <Summary>
      <AdjustmentsFee>
        <Amount>0.0</Amount>
      </AdjustmentsFee>
      <AdvanceFees>
        <Amount>0.0</Amount>
      </AdvanceFees>
      <ChargesFee>
        <Amount>1.27</Amount>
      </ChargesFee>
      <RefundsFee>
        <Amount>0.0</Amount>
      </RefundsFee>
      <ReservedFundsFee>
        <Amount>0.0</Amount>
      </ReservedFundsFee>
      <RetriedPayoutsFee>
        <Amount>0.0</Amount>
      </RetriedPayoutsFee>
    </Summary>
    <TransactionType>DEPOSIT</TransactionType>
  </ShopifyPaymentsPayout>
</ShopifyPaymentsPayouts>