Item Information

The information for a purchased item in a disputed transaction.

Schema Information

Type:object

Properties

item_id

Type: string

Pattern: ^.*$

Min length: 1

Max length: 255

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_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 2000

The item name.

item_description

Type: string

Pattern: ^(.|\r?\n)*$

Min length: 1

Max length: 2000

The item description.

item_quantity

Type: string

Pattern: ^[1-9][0-9]{0,9}$

Min length: 1

Max length: 10

The count of the item in the dispute. Must be a whole number.

partner_transaction_id

Type: string

Pattern: ^[A-Za-z0-9]+$

Min length: 1

Max length: 255

The ID of the transaction in the partner system. The partner transaction ID is returned at an item level because the partner might show different transactions for different items in the cart.

reason

Type: string

Enum:

"MERCHANDISE_OR_SERVICE_NOT_RECEIVED", "MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED", "UNAUTHORISED", "CREDIT_NOT_PROCESSED", "DUPLICATE_TRANSACTION", "INCORRECT_AMOUNT", "PAYMENT_BY_OTHER_MEANS", "CANCELED_RECURRING_BILLING", "PROBLEM_WITH_REMITTANCE", "OTHER"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see dispute reasons.

dispute_amount

Type: object

The amount of the item in the dispute.

currency_coderequired

Type: string

Format: ppaas_common_currency_code_v2

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Min length: 0

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

notes

Type: string

Pattern: ^(.|\r?\n)*$

Min length: 1

Max length: 2000

Any notes provided with the item.

item_type

Type: string

Enum: "PRODUCT", "SERVICE", "BOOKING", "DIGITAL_DOWNLOAD"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The type of the item which has the issue.

product_details

service_details

booking_details

digital_download_details

cancellation_details

agreed_refund_details

Properties

item_id

Type: string

Pattern: ^.*$

Min length: 1

Max length: 255

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_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 2000

The item name.

item_description

Type: string

Pattern: ^(.|\r?\n)*$

Min length: 1

Max length: 2000

The item description.

item_quantity

Type: string

Pattern: ^[1-9][0-9]{0,9}$

Min length: 1

Max length: 10

The count of the item in the dispute. Must be a whole number.

partner_transaction_id

Type: string

Pattern: ^[A-Za-z0-9]+$

Min length: 1

Max length: 255

The ID of the transaction in the partner system. The partner transaction ID is returned at an item level because the partner might show different transactions for different items in the cart.

reason

Type: string

Enum:

"MERCHANDISE_OR_SERVICE_NOT_RECEIVED", "MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED", "UNAUTHORISED", "CREDIT_NOT_PROCESSED", "DUPLICATE_TRANSACTION", "INCORRECT_AMOUNT", "PAYMENT_BY_OTHER_MEANS", "CANCELED_RECURRING_BILLING", "PROBLEM_WITH_REMITTANCE", "OTHER"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see dispute reasons.

dispute_amount

Type: object

The amount of the item in the dispute.

currency_coderequired

Type: string

Format: ppaas_common_currency_code_v2

Min length: 3

Max length: 3

The three-character ISO-4217 currency code that identifies the currency.

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Min length: 0

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

notes

Type: string

Pattern: ^(.|\r?\n)*$

Min length: 1

Max length: 2000

Any notes provided with the item.

item_type

Type: string

Enum: "PRODUCT", "SERVICE", "BOOKING", "DIGITAL_DOWNLOAD"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The type of the item which has the issue.

product_details

service_details

booking_details

digital_download_details

cancellation_details

agreed_refund_details

Item Information

Schema Information

Properties

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Item Information

Schema Information

Properties