Skip to main content

List Storefront Payout Lines

GET 

/api/storefront/payout-lines

Lists every payout line across the Stripe payouts your Storefront stores report (narrow with filter[integration_instance_ids]), newest first. A line is one balance change a payout settles: a charge, refund, dispute, dispute reversal, standalone fee, adjustment, reserve or transfer. gross, fee and net are decimal strings in the payout currency (net = gross - fee). matched is true when the line was matched to a SKU.io sales order (sales_order_id, sales_order_number); payout names the payout the line belongs to. type is Stripe's own word for the line: Stripe calls a card payment a charge and a payment made with any other method (buy now, pay later, Link, Cash App Pay, bank debits) a payment. Both are customer payments in category charge and post the same way. payment_method_type / payment_method_label name the method actually used (affirm / Affirm, card / Card; for a refund or dispute, the payment it gives back), or are null when the store did not report it (fees, transfers, and lines read before the store reported methods; re-reading the payout's lines fills them in). Requires an API token with accounting:read.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request​

Responses​

OK

Response Headers
    Content-Type