API version 2021-01 Release candidate
API version 2020-10 Latest
API version 2020-07
API version 2020-04
API version 2020-01
API version 2019-10 Unsupported
API version 2019-07 Unsupported

ShopifyPaymentsPayoutSummary object

Version 2021-01 (Release candidate)

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

Version 2020-10 (Latest)

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

Version 2020-07

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

Version 2020-04

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

Version 2020-01

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

Version 2019-10 (Unsupported)

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

Version 2019-07 (Unsupported)

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary

Version 2019-04 (Unsupported)

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.

Fields

adjustmentsFee (MoneyV2!)

Total fees for all adjustments including disputes.

adjustmentsGross (MoneyV2!)

Total gross amount for all adjustments including disputes.

chargesFee (MoneyV2!)

Total fees for all charges.

chargesGross (MoneyV2!)

Total gross amount for all charges.

refundsFee (MoneyV2!)

Total fees for all refunds.

refundsFeeGross (MoneyV2!)

Total gross amount for all refunds.

reservedFundsFee (MoneyV2!)

Total fees for all reserved funds.

reservedFundsGross (MoneyV2!)

Total gross amount for all reserved funds.

retriedPayoutsFee (MoneyV2!)

Total fees for all retried payouts.

retriedPayoutsGross (MoneyV2!)

Total gross amount for all retried payouts.

Types that return ShopifyPaymentsPayoutSummary