eBay · Schema

PayoutInstrument

This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
accountLastFourDigits	string	This value is the last four digits of the account that the seller uses to receive the payout. This may be the last four digits of a bank account, a debit card, or a payment processor account such as P
instrumentType	string	This value indicates the type of account that received the payout. The value returned in this field may be: `BANK`: indicates that the payout was made to a seller's bank account.
nickname	string	When instrumentType returns `BANK`, this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout. When instrumentT
payoutPercentage	string	This value indicates the current payout percentage allocated to a payout instrument. For example, `50` indicates that 50% of the payout goes to the instrument. This field will be ret

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PayoutInstrument",
  "title": "PayoutInstrument",
  "type": "object",
  "properties": {
    "accountLastFourDigits": {
      "type": "string",
      "description": "This value is the last four digits of the account that the seller uses to receive the payout. This may be the last four digits of a bank account, a debit card, or a payment processor account such as Payoneer."
    },
    "instrumentType": {
      "type": "string",
      "description": "This value indicates the type of account that received the payout. The value returned in this field may be:<br><ul><li><code>BANK</code>: indicates that the payout was made to a seller's bank account.</li><li><code>CARD</code>: indicates that the payout went to a seller's debit card</li><li>The name of a digital wallet provider or payment processor (e.g., <code>PAYONEER</code>)</li></ul><br><br><span class=\"tablenote\"><b>Note:</b> Only Payoneer is currently supported for sellers in mainland China. Card payouts are not currently available for sellers in mainland China.</span>"
    },
    "nickname": {
      "type": "string",
      "description": "When <b>instrumentType</b> returns <code>BANK</code>, this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout.<br><br>When <b>instrumentType</b> returns <code>CARD</code>, this value is the debit card network for the debit card that receives the payout.<br><br>When <b>instrumentType</b> returns a provider of digital wallet or payment processing services, the value returned is the name of the service provider (e.g., <code>PAYONEER</code>).<br><br><span class=\"tablenote\"><b>Note:</b> Card payouts are not currently available for sellers in mainland China.</span>"
    },
    "payoutPercentage": {
      "type": "string",
      "description": "This value indicates the current payout percentage allocated to a payout instrument. For example, <code>50</code> indicates that 50% of the payout goes to the instrument.<br><br>This field will be returned even when 100% of the payout funds are going to one payout instrument.<br><br>This field is only returned to sellers in mainland China."
    }
  },
  "description": "This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts."
}