eBay · Schema

PayoutSummaryResponse

This type is the base response type of the getPayoutSummary method, and contains the total count of seller payouts (that match the input criteria), the total count of monetary transactions (order payment, buyer refunds, or seller credits) associated with those payouts, and the total value of those seller payouts.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
amount object This container shows the total value (and currency type used) of the seller payouts that match the input criteria. This field is not returned if there are no payouts that match the input criteria.
payoutCount integer This integer value indicates the total count of payouts to the seller that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its valu
transactionCount integer This integer value indicates the total count of monetary transactions (order payments, buyer refunds, and seller credits) associated with the payouts that match the input criteria. This field is alway
View JSON Schema on GitHub

JSON Schema

ebay-payoutsummaryresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PayoutSummaryResponse",
  "title": "PayoutSummaryResponse",
  "type": "object",
  "properties": {
    "amount": {
      "description": "This container shows the total value (and currency type used) of the seller payouts that match the input criteria. This field is not returned if there are no payouts that match the input criteria.",
      "$ref": "#/components/schemas/Amount"
    },
    "payoutCount": {
      "type": "integer",
      "description": "This integer value indicates the total count of payouts to the seller that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show <code>0</code>).",
      "format": "int32"
    },
    "transactionCount": {
      "type": "integer",
      "description": "This integer value indicates the total count of monetary transactions (order payments, buyer refunds, and seller credits) associated with the payouts that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show <code>0</code>). If there is at least one payout that matches the input criteria, the value in this field will be at least <code>1</code>.",
      "format": "int32"
    }
  },
  "description": "This type is the base response type of the <strong>getPayoutSummary</strong> method, and contains the total count of seller payouts (that match the input criteria), the total count of monetary transactions (order payment, buyer refunds, or seller credits) associated with those payouts, and the total value of those seller payouts."
}