Skip to content

Payouts

The Payouts pull reads the Shopify Payments payouts issued since its last run, for reconciling the bank account the payouts reach. Each payout record carries its totals of charges, refunds, adjustments and fees. The balance transactions it settles sit beneath it: the charges, refunds and fees on each order.

The pull needs a store that takes payments through Shopify Payments.

On a reader, select Payouts as the Shopify Entity.

Reader Options

Option Values Default
Payout Status scheduled, in_transit, paid, failed, canceled, or all for every status paid
Orders placed in the last A time span: a number and d, h, m or s, such as 30d None. A preview needs it

The pull reads the payouts that have the status chosen and fall inside its time window:

  • A preview or refresh in the Designer reads the payouts issued in the span that Orders placed in the last gives. The option names orders, but sets the span for this pull too. The Designer needs a span, and reports an error without one.
  • A run outside the Designer reads the payouts issued since its last run. The first run reads every payout.

The pull reads through Shopify's GraphQL Admin API. Leave API and Timestamps empty. The other options have no effect.

Records

The pull returns a Payout record for each payout, with a Transaction record for each balance transaction it settles.

Payout

  • id and legacy_id, the payout's Shopify ids;
  • issued_at, status and transaction_type;
  • currency and net_amount, the amount paid to the bank;
  • the gross amount and fee for each kind of transaction the payout settles: charges_gross and charges_fee, refunds_gross and refunds_fee, adjustments_gross and adjustments_fee, reserved_funds_gross and reserved_funds_fee, retried_payouts_gross and retried_payouts_fee.

Transaction

  • id, transaction_date and type, such as a charge, refund or adjustment;
  • amount, fee, net and currency;
  • source_id, source_type and source_order_transaction_id, the Shopify record that caused it;
  • order_id and order_name, the order it belongs to, where it has one;
  • payout_status.

A balance transaction that no payout has settled yet does not appear.

Running from a Schedule

The pull keeps its last run time as the Orders pull does, in the same lookup table. See Running from a Schedule for resetting it and for filtering out duplicates. Record the payout's id in the target system, and filter out a payout it already holds.

Access Scopes

The pull needs read_shopify_payments_accounts and read_shopify_payments_payouts. See Access Scopes.

Shopify Reference

ShopifyPaymentsPayout and ShopifyPaymentsBalanceTransaction in Shopify's GraphQL Admin API reference.