ShopifyPaymentsPayoutSummary object

Breakdown of the total fees and gross of each of the different types of transactions associated with the payout.

Required access

read_shopify_payments access scope. Also: User must have the shopify_payments_transfers permission.

On this page

Fields

  • adjustmentsFee ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total fees for all adjustments including disputes.
  • adjustmentsGross ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total gross amount for all adjustments including disputes.
  • chargesFee ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total fees for all charges.
  • chargesGross ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total gross amount for all charges.
  • refundsFee ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total fees for all refunds.
  • refundsFeeGross ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total gross amount for all refunds.
  • reservedFundsFee ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total fees for all reserved funds.
  • reservedFundsGross ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total gross amount for all reserved funds.
  • retriedPayoutsFee ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total fees for all retried payouts.
  • retriedPayoutsGross ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

  • [ShopifyPaymentsPayout.summary](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentspayout#summary-2021-01)