On this page
No Headings
The billing issue details.
objectduplicate_transactionobjectThe duplicate transaction details.
received_duplicatebooleanIf true, indicates that a duplicate transaction was received.
original_transactionobjectThe transaction details for the original transaction, when the dispute reason is DUPLICATE_TRANSACTION. Currently, contains only the date and amount.
buyer_transaction_idstring^[A-Za-z0-9-]+$The ID, as seen by the customer, for this transaction.
seller_transaction_idstring^[A-Za-z0-9-]+$The ID, as seen by the merchant, for this transaction.
reference_idstring^.*$The ID, as seen by the partner, for this transaction.
create_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the transaction was created, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
transaction_statusstring"COMPLETED", "UNCLAIMED", "DENIED", "FAILED", "HELD", "PENDING", "PARTIALLY_REFUNDED", "REFUNDED", "REVERSED", "CANCELLED"^[0-9A-Z_]+$The transaction status.
gross_amountobjectThe gross amount of the transaction.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.gross_assetobjectThe gross asset of the transaction.
asset_symbolrequiredstring"BTC", "ETH", "BCH", "LTC", "PYUSD", "LINK", "SOL", "MATIC"^[0-9A-Za-z]{1,10}$The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
quantityrequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The quantity of a cryptocurrency asset. This is a decimal number with a scale defined for each cryptocurrency by its founders. For example, Bitcoin (BTC) has 8 as its scale, Ethereum (ETH) has 18 as its scale. The PayPal Cryptocurrency platform handles the scale to 8 digits for Bitcoin. including its forks or offshoots, as well as Ethereum.
quantity_in_subunitsstring^-?[0-9]+$The quantity of a cryptocurrency asset in the currency's sub units.
Amount is an integer in a string format.
Floating point should be avoided to avoid precision errors. For example:
decimalsintegerThe number of decimal digits supported by this cryptocurrency. For example, for Bitcoin this value is 8 because there are 10^8 satoshis in one Bitcoin and for Ethereum it's 18 since there are 10^18 wei in one Ether.
invoice_numberstring^[A-Za-z0-9:\-|]+$The ID of the invoice for the payment.
customstring^(.|\r?\n)*$A free-text field that is entered by the merchant during checkout.
buyerobjectThe details for the customer who funds the payment. For example, the customer's first name, last name, and email address.
namestring^[^~!@#$%^*()_{}:|\t\n/]+$The customer's name.
sellerobjectThe details for the merchant who receives the funds and fulfills the order. For example, merchant ID, and contact email address.
emailstringppaas_common_email_address_v2^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$The email address for the merchant's PayPal account.
merchant_idstring^[0-9A-Za-z]+$The PayPal account ID for the merchant.
namestring^[^~!@#$%^*()_{}:|\t\n/]+$The name of the merchant.
itemsarrayAn array of items that were purchased as part of the transaction.
itemsobjectThe information for a purchased item in a disputed transaction.
item_idstring^.*$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_namestring^.*$The item name.
item_descriptionstring^(.|\r?\n)*$The item description.
item_quantitystring^[1-9][0-9]{0,9}$The count of the item in the dispute. Must be a whole number.
partner_transaction_idstring^[A-Za-z0-9]+$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.
reasonstring"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"^[0-9A-Z_]+$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_amountobjectThe amount of the item in the dispute.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.notesstring^(.|\r?\n)*$Any notes provided with the item.
item_typestring"PRODUCT", "SERVICE", "BOOKING", "DIGITAL_DOWNLOAD"^[0-9A-Z_]+$The type of the item which has the issue.
product_detailsservice_detailsbooking_detailsdigital_download_detailscancellation_detailsagreed_refund_detailspayment_processorincorrect_transaction_amountobjectThe incorrect transaction amount details.
correct_transaction_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.correct_transaction_assetobjectThe correct asset quantity of the transaction.
asset_symbolrequiredstring"BTC", "ETH", "BCH", "LTC", "PYUSD", "LINK", "SOL", "MATIC"^[0-9A-Za-z]{1,10}$The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
quantityrequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The quantity of a cryptocurrency asset. This is a decimal number with a scale defined for each cryptocurrency by its founders. For example, Bitcoin (BTC) has 8 as its scale, Ethereum (ETH) has 18 as its scale. The PayPal Cryptocurrency platform handles the scale to 8 digits for Bitcoin. including its forks or offshoots, as well as Ethereum.
quantity_in_subunitsstring^-?[0-9]+$The quantity of a cryptocurrency asset in the currency's sub units.
Amount is an integer in a string format.
Floating point should be avoided to avoid precision errors. For example:
decimalsintegerThe number of decimal digits supported by this cryptocurrency. For example, for Bitcoin this value is 8 because there are 10^8 satoshis in one Bitcoin and for Ethereum it's 18 since there are 10^18 wei in one Ether.
correct_transaction_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the customer created the transaction, in Internet date and time format.
payment_by_other_meansobjectThe payment by other means details.
charge_different_from_originalbooleanIf true, indicates that a charge was made that is different from the original charge.
received_duplicatebooleanIf true, indicates that a duplicate transaction was received.
payment_methodstring"CASH", "CREDIT_CARD", "CHECK", "PAYPAL", "DEBIT_CARD", "GIFT_CARD", "BANK_TRANSFER"^[0-9A-Z_]+$The payment method.
payment_instrument_suffixstring^.*$Last 2-4 characters of the payment instrument. For payment_method CHECK, payment_instrument_suffix entered must be of minimum length 2-4 characters. For payment_method CREDIT_CARD, DEBIT_CARD, GIFT_CARD, BANK_TRANSFER, payment_instrument_suffix entered must be of length 4.
credit_not_processedobjectThe credit not processed details.
issue_typestring"PRODUCT", "SERVICE"^[0-9A-Z_]+$The issue type.
expected_refundobjectThe currency and amount for a financial transaction, such as a balance or payment due.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.cancellation_detailsobjectThe cancellation details.
cancellation_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time of the cancellation, in Internet date and time format.
cancellation_numberstring^.*$The cancellation number.
cancelledbooleanIndicates whether the dispute was canceled.
cancellation_modestring"CANCELLED_PAYPAL_BILLING_AGREEMENT", "WEBSITE", "PHONE", "EMAIL", "WRITTEN", "IN_PERSON"^[0-9A-Z_]+$Indicates the mode used for order cancellation.
product_detailsobjectThe product information.
descriptionstring^(.|\r?\n)*$The product description.
product_receivedstring"YES", "NO", "RETURNED"^[0-9A-Z_]+$Indicates whether the product was, or was not, received or returned.
product_received_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when product was delivered.
expected_delivery_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The expected delivery date and time of the product.
sub_reasonsarrayAn array of sub-reasons for the product issue.
itemsstring"DAMAGED", "DIFFERENT", "MISSING_PARTS", "OTHER"^[0-9A-Z_]+$The sub-reason for the product issue.
purchase_urlstringuriThe URL where the customer purchased the product.
return_detailsobjectThe return details for the product.
return_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the product was returned, Internet date and time format.
modestring"SHIPPED", "IN_PERSON"^[A-Z_]+$The method that the customer used to return the product.
receiptbooleanIndicates whether customer has the return receipt.
return_confirmation_numberstring^[A-Za-z0-9:\-]+$The confirmation number for the item return.
returnedbooleanIf true, indicates that the item was returned but the seller refused to accept the return and if false, indicates the item was not attempted to return.
service_detailsobjectThe service details.
descriptionstring^(.|\r?\n)*$The service description.
service_startedstring"YES", "NO", "CANCELLED"^[0-9A-Z_]+$Indicates whether the service was started or cancelled.
notestring^(.|\r?\n)*$The customer specified note about the service usage.
sub_reasonsarrayAn array of sub-reasons for the service issue.
itemsstring"DAMAGED", "DIFFERENT", "INCOMPLETE", "OTHER"^[0-9A-Z_]+$The sub-reason for the service issue.
purchase_urlstringuriThe URL of the merchant or marketplace site where the customer purchased the service.
agreed_refund_detailsobjectDetails of Agreed Refund between customer and merchant.
merchant_agreed_refundbooleanIndicates whether merchant has agreed to refund the buyer or not.
merchant_agreed_refund_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time proposed by merchant to provide the refund, in Internet date and time format.
canceled_recurring_billingobjectThe recurring billing canceled details.
expected_refundobjectThe currency and amount for a financial transaction, such as a balance or payment due.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.cancellation_detailsobjectThe cancellation details.
cancellation_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time of the cancellation, in Internet date and time format.
cancellation_numberstring^.*$The cancellation number.
cancelledbooleanIndicates whether the dispute was canceled.
cancellation_modestring"CANCELLED_PAYPAL_BILLING_AGREEMENT", "WEBSITE", "PHONE", "EMAIL", "WRITTEN", "IN_PERSON"^[0-9A-Z_]+$Indicates the mode used for order cancellation.