PayPal · Schema

Evidence

A merchant- or customer-submitted evidence document. evidence_info is expected for PROOF_OF_FULFILLMENT,PROOF_OF_REFUND and PROOF_OF_RETURN evidence types. documents and notes can be given for rest of the evidence types.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
evidence_type string The evidence type.
evidence_info object
documents array An array of evidence documents.
notes string Any evidence-related notes.
source string The source of the evidence.
date object The date and time when the evidence was received, in [Internet date and time format](http://tools.ietf.org/html/rfc3339#section-5.6).
item_id string The item ID. If the merchant provides multiple pieces of evidence and the transaction has multiple item IDs, the merchant can use this value to associate a piece of evidence with an item ID.
item_type object The item type for which the evidence is requested or submitted.
action_info object The action details for the information. Includes additional information such as the action for which the evidence was requested/submitted, and whether the evidence is mandatory for the corresponding a
dispute_life_cycle_stage object The dispute life cycle stage for the evidence.
View JSON Schema on GitHub

JSON Schema

paypal-evidence-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/evidence",
  "title": "Evidence",
  "type": "object",
  "description": "A merchant- or customer-submitted evidence document. evidence_info is expected for PROOF_OF_FULFILLMENT,PROOF_OF_REFUND and PROOF_OF_RETURN evidence types. documents and notes can be given for rest of the evidence types.",
  "properties": {
    "evidence_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[0-9A-Z_]+$",
      "description": "The evidence type.",
      "enum": [
        "PROOF_OF_FULFILLMENT",
        "PROOF_OF_REFUND",
        "PROOF_OF_DELIVERY_SIGNATURE",
        "PROOF_OF_RECEIPT_COPY",
        "RETURN_POLICY",
        "BILLING_AGREEMENT",
        "PROOF_OF_RESHIPMENT",
        "ITEM_DESCRIPTION",
        "POLICE_REPORT",
        "AFFIDAVIT",
        "PAID_WITH_OTHER_METHOD",
        "COPY_OF_CONTRACT",
        "TERMINAL_ATM_RECEIPT",
        "PRICE_DIFFERENCE_REASON",
        "SOURCE_CONVERSION_RATE",
        "BANK_STATEMENT",
        "CREDIT_DUE_REASON",
        "REQUEST_CREDIT_RECEIPT",
        "PROOF_OF_RETURN",
        "CREATE",
        "CHANGE_REASON",
        "PROOF_OF_REFUND_OUTSIDE_PAYPAL",
        "RECEIPT_OF_MERCHANDISE",
        "CUSTOMS_DOCUMENT",
        "CUSTOMS_FEE_RECEIPT",
        "INFORMATION_ON_RESOLUTION",
        "ADDITIONAL_INFORMATION_OF_ITEM",
        "DETAILS_OF_PURCHASE",
        "PROOF_OF_SIGNIFICANT_DIFFERENCE",
        "PROOF_OF_SOFTWARE_OR_SERVICE_NOT_AS_DESCRIBED",
        "PROOF_OF_CONFISCATION",
        "PROOF_OF_DAMAGE",
        "COPY_OF_LAW_ENFORCEMENT_AGENCY_REPORT",
        "ADDITIONAL_PROOF_OF_SHIPMENT",
        "PROOF_OF_DENIAL_BY_CARRIER",
        "THIRDPARTY_PROOF_FOR_DAMAGE_OR_SIGNIFICANT_DIFFERENCE",
        "VALID_SUPPORTING_DOCUMENT",
        "LEGIBLE_SUPPORTING_DOCUMENT",
        "RETURN_TRACKING_INFORMATION",
        "DELIVERY_RECEIPT",
        "PROOF_OF_INSTORE_RECEIPT",
        "ADDITIONAL_TRACKING_INFORMATION",
        "PROOF_OF_SHIPMENT_POSTAGE",
        "ONLINE_TRACKING_INFORMATION",
        "PROOF_OF_INSTORE_REFUND",
        "PROOF_FOR_SOFTWARE_OR_SERVICE_DELIVERED",
        "RETURN_ADDRESS_FOR_SHIPPING",
        "COPY_OF_THE_EPARCEL_MANIFEST",
        "COPY_OF_SHIPPING_MANIFEST",
        "APPEAL_AFFIDAVIT",
        "RECEIPT_OF_REPLACEMENT",
        "COPY_OF_DRIVERS_LICENSE",
        "ACCOUNT_CHANGE_INFORMATION",
        "DELIVERY_ADDRESS",
        "CONFIRMATION_OF_RESOLUTION",
        "MERCHANT_RESPONSE",
        "PERMISSION_DESCRIPTION",
        "STATUS_OF_MERCHANDISE",
        "LOST_CARD_DETAILS",
        "LAST_VALID_TRANSACTION_DETAILS",
        "ADDITIONAL_PROOF_OF_RETURN",
        "DECLARATION",
        "PROOF_OF_MISSING_ITEMS",
        "PROOF_OF_EMPTY_PACKAGE_OR_DIFFERENT_ITEM",
        "PROOF_OF_ITEM_NOT_RECEIVED",
        "ORDER_DETAILS",
        "LISTING_URL",
        "SHIPPING_INSURANCE",
        "BUYER_RESPONSE",
        "PHOTOS_OF_SHIPPED_ITEM",
        "OTHER"
      ]
    },
    "evidence_info": {
      "$ref": "#/components/schemas/evidence_info"
    },
    "documents": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "description": "An array of evidence documents.",
      "items": {
        "$ref": "#/components/schemas/document"
      }
    },
    "notes": {
      "type": "string",
      "description": "Any evidence-related notes.",
      "minLength": 1,
      "maxLength": 2000
    },
    "source": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[A-Z_]+$",
      "readOnly": true,
      "description": "The source of the evidence.",
      "enum": [
        "REQUESTED_FROM_BUYER",
        "REQUESTED_FROM_SELLER",
        "SUBMITTED_BY_BUYER",
        "SUBMITTED_BY_SELLER",
        "SUBMITTED_BY_PARTNER"
      ]
    },
    "date": {
      "readOnly": true,
      "$ref": "#/components/schemas/date_time",
      "description": "The date and time when the evidence was received, in [Internet date and time format](http://tools.ietf.org/html/rfc3339#section-5.6)."
    },
    "item_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[A-Za-z0-9]+$",
      "description": "The item ID. If the merchant provides multiple pieces of evidence and the transaction has multiple item IDs, the merchant can use this value to associate a piece of evidence with an item ID."
    },
    "item_type": {
      "readOnly": true,
      "description": "The item type for which the evidence is requested or submitted.",
      "$ref": "#/components/schemas/item_type"
    },
    "action_info": {
      "readOnly": true,
      "description": "The action details for the information. Includes additional information such as the action for which the evidence was requested/submitted, and whether the evidence is mandatory for the corresponding action.",
      "$ref": "#/components/schemas/action_info"
    },
    "dispute_life_cycle_stage": {
      "readOnly": true,
      "description": "The dispute life cycle stage for the evidence.",
      "$ref": "#/components/schemas/dispute_lifecycle_stage"
    }
  }
}