On this page
No Headings
The dispute details.
objectdispute_idstring^[A-Za-z0-9-]+$The ID of the dispute.
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 dispute was created, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
update_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 dispute was last updated, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
disputed_transactionsarrayAn array of transactions for which disputes were created.
itemsobjectThe information about the disputed transaction.
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_processorreasonstring"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.
statusstring"OPEN", "WAITING_FOR_BUYER_RESPONSE", "WAITING_FOR_SELLER_RESPONSE", "UNDER_REVIEW", "RESOLVED", "OTHER"^[0-9A-Z_]+$The overall status of the dispute, constant for all the parties involved at anytime during the dispute lifecycle.
dispute_amountobjectThe amount in the transaction that the customer originally disputed. Because customers can sometimes dispute only part of the payment, the disputed amount might be different from the total gross or net amount of the original 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.dispute_assetobjectThe asset in the transaction that the customer disputed.
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.
fee_policyobjectPolicy that determines whether the fee needs to be charged, retained or returned while moving the money as part of dispute process.
external_reason_codestring^[A-Za-z0-9._-]+$The code that identifies the reason for the credit card chargeback. Each card issuer follows their own standards for defining reason type, code, and its format. For more details about the external reason code, see the card issue site. Available for only unbranded transactions.
dispute_outcomeobjectThe outcome of a dispute.
outcome_codestring"RESOLVED_BUYER_FAVOUR", "RESOLVED_SELLER_FAVOUR", "RESOLVED_WITH_PAYOUT", "CANCELED_BY_BUYER", "ACCEPTED", "DENIED", "NONE"^[A-Z0-9_]+$The outcome of a resolved dispute.
outcome_reasonstring"AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES", "BILLING_AGREEMENT_CHANGE_DISCLOSED", "BILLING_AGREEMENT_CHANGE_NOT_DISCLOSED", "BILLING_AGREEMENT_DATE_CHANGE_DISCLOSED", "BILLING_AGREEMENT_DATE_CHANGE_NOT_DISCLOSED", "BUYER_ATTEMPTED_RETURN", "BUYER_BILLED_ONLY_ONCE", "BUYER_CANCELLED_CASE", "BUYER_CANCELLED_SERVICE", "BUYER_FAILED_TO_DESCRIBE_ISSUE", "BUYER_HAS_POSSESSION_OF_THE_MERCHANDISE_OR_SERVICE", "BUYER_MADE_NO_ATTEMPT_TO_RESOLVE_WITH_SELLER", "BUYER_NOT_IN_POSSESSION_OF_ITEM_TO_RETURN", "BUYER_PROVIDED_CREDIT_RECEIPT", "BUYER_RECEIVED_DUPLICATE_REFUND", "CANCELLED_PER_TERMS_OF_BILLING_AGREEMENT", "CARD_NOT_STOLEN", "CARD_NOT_STOLEN_BEFORE_AUTH", "CUSTOMER_RECOGNIZES_TRANSACTION", "DECISION_BASED_ON_AVAILABLE_INFORMATION", "DELIVERY_AFTER_EXPECTED_DELIVERY_DATE", "DELIVERY_DUE_WITHIN_EXPECTED_DELIVERY_DATE", "DELIVERY_OR_SERVICE_REFUSED", "DOCUMENTATION_MATCHES_AMOUNT_CHARGED", "DOCUMENTATION_MATCHES_AMOUNT_IN_PAYPAL_ACCOUNT", "DUPLICATE_ADD_FUNDS", "EFFORTLESS_SELLER_PROTECTION", "IN_PERSON_DELIVERY", "INELIGIBLE_BUYER_PROTECTION_POLICY", "INELIGIBLE_SELLER_PROTECTION_POLICY", "INQUIRY_OFFER_ITEM_REPLACED", "INQUIRY_OFFER_PARTIAL_REFUND", "INQUIRY_OFFER_REFUND_WITH_ITEM_RETURN", "INQUIRY_OFFER_REFUND_WITH_REPLACEMENT", "INVALID_APPEAL_REASON", "INVALID_CHARGEBACK_SELLER_FAVOUR", "INVALID_DELIVERY_PROOF", "INVALID_DELIVERY_PROOF_SIGNATURE", "INVALID_DOCUMENTATION", "INVALID_PROOF_OF_SHIPMENT", "INVALID_REFUND_PROOF", "INVALID_RETURN_DELIVERY_NO_SIGNATURE_PROOF", "INVALID_RETURN_DELIVERY_PROOF", "INVALID_TRACKING", "ITEM_ALTERED_REPAIRED", "ITEM_NOT_AS_ADVERTISED", "ITEM_NOT_AS_DESCRIBED", "ITEM_NOT_DAMAGED", "ITEM_NOT_DELIVERED", "ITEM_NOT_RETURNED_TO_SELLER", "ITEM_NOT_SHIPPED", "ITEM_OF_DIFFERENT_QUALITY_OR_QUANTITY", "ITEM_OUT_OF_STOCK_AND_NOT_DELIVERED", "ITEM_RETURNED_TO_SELLER", "ITEM_SERVICE_MISREPRESENTED", "ITEM_SERVICE_NOT_MISREPRESENTED", "ITEM_SERVICE_RECEIVED_BY_BUYER", "ITEM_SOLD_AS_DESCRIBED", "ITEM_VALUE_UNAFFECTED", "MULTIPLE_APPEALS_WITH_SAME_REASON", "NO_DOCUMENTATION_FROM_BUYER", "NO_DOCUMENTATION_SUPPORTING_DUE_OF_CREDIT", "NO_PROOF_OF_DELIVERY", "NO_PROOF_OF_DELIVERY_INTANGIBLE", "NO_PROTECTION_FOR_DIGITAL_GOODS_SERVICE", "NO_RESPONSE_FROM_BUYER", "NO_RESPONSE_FROM_BUYER_FOR_ADDITIONAL_INFO_REQUEST", "NO_SELLER_RESPONSE", "NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST", "NO_VALID_SHIPMENT_PROOF", "NOT_A_BILLING_ERROR", "NOT_AN_UNAUTHORIZED_TRANSACTION", "NOT_DUPLICATE_FUNDS_ADDED_ONCE", "NOT_DUPLICATE_FUNDS_WITHDRAWN_ONCE", "NOT_SHIPPED_TO_CORRECT_ADDRESS", "PARTIAL_REFUND_ISSUED_FOR_MISSING_ITEMS", "PARTIAL_REFUND_OFFER_ACCEPTED", "PAYMENT_REVERSED_ALREADY", "POS_SUBMITTED_INSTEAD_OF_POD", "PREAUTH_INSTALLMENT_DUE", "PROOF_OF_BILLING_AFTER_CANCELLATION_ACCEPTED", "PROOF_OF_DUPLICATE_DENIED_OR_INSUFFICIENT", "PROOF_OF_INCORRECT_TRANSACTION_AMOUNT_ACCEPTED", "PROOF_OF_PAID_BY_OTHER_MEANS_NOT_SUBMITTED", "PROOF_OF_TRACKING_NOT_SUBMITTED", "PROTECTED_BY_PAYPAL", "REPRESENTED_BY_PAYPAL", "SELLER_ACCEPTED_MULTIPLE_PAYMENTS", "SELLER_AGREED_REFUND_WITHOUT_RETURN", "SELLER_AGREED_TO_ISSUE_CREDIT", "SELLER_ISSUED_CREDIT_TO_BUYER", "SELLER_ISSUED_REFUND", "SELLER_NOT_REACHABLE", "SELLER_RECEIVED_PAYMENT_TWICE_OR_FOR_REPLACEMENT", "SELLER_REFUSED_REFUND", "SELLER_REFUSED_RETURN", "SELLER_SURCHARGED_BUYER", "SERVICE_NOT_COMPLETED_AS_AGREED", "SHIPPING_COMPANY_WONT_SHIP", "TRACKING_PROOF_NOT_ENOUGH", "TRANSACTION_AUTHORIZED_BY_CARDHOLDER", "TRANSACTION_CANCELLED_AFTER_AUTHORIZATION_DATE", "TRANSACTION_CANCELLED_BEFORE_SHIPMENT_SERVICE_DATE", "TRANSACTION_MATCHES_BUYER_SPENDING_PATTERN", "TRANSACTION_PROCESSED_CORRECTLY", "TRUSTED_BUYER_PAYOUT", "UNUSED_SHIPPING_LABEL", "VALID_PROOF_OF_DELIVERY", "VALID_PROOF_OF_DELIVERY_WITH_SIGNATURE", "VALID_PROOF_OF_REFUND", "VALID_PROOF_SUPPORTING_CLAIM", "VALID_RETURN_DELIVERY_PROOF", "VALID_RETURN_DELIVERY_PROOF_WITH_SIGNATURE", "VALID_SHIPMENT_PROOF", "VALUE_AFFECTED_SIGNIFICANTLY", "PROTECTION_POLICY_APPLIES", "SNAD_DELAYED_FILING", "FUNDS_TRANSFERRED_TO_INCORRECT_RECIPIENT", "NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST", "IN_TRANSIT_BEYOND_TIMEFRAME_INVALID_PROOF_OF_SHIPMENT_OR_DELIVERY", "VALID_PROOF_SUPPORTING_CLAIM", "INVALID_EVIDENCE", "INVALID_PROOF_DELIVERED_TO_UNSPECIFIED_LOCATION", "INVALID_PROOF_DELIVERED_TO_INCORRECT_ADDRESS", "INVALID_PROOF_UNABLE_TO_TRACK", "SHIPPING_ADDRESS_NOT_PRESENT_IN_PROOF_OF_SHIPMENT_OR_DELIVERY", "INVALID_PROOF_ITEM_RETURNED_TO_SENDER", "DELIVERED_WITHOUT_REQUIRED_SIGNATURE_IN_PROOF_OF_DELIVERY", "NO_SHIPMENT_TRACKING_PROVIDED_IN_PROOF_OF_DELIVERY", "OTHER_ISSUE_WITH_PROOF_OF_SHIPMENT_OR_DELIVERY", "INSUFFICIENT_EVIDENCE_PROVIDED", "EVIDENCE_CANNOT_BE_LINKED_TO_TRANSACTION", "EVIDENCE_DOES_NOT_SHOW_FULFILLMENT_OR_CUSTOMER_BENEFIT", "SELLER_SHIPPED_OR_FULFILLED_BEYOND_ALLOWED_PERIOD", "ITEM_INELIGIBLE_FOR_SELLER_PROTECTION", "EVIDENCE_DOES_NOT_SHOW_SERVICE_COMPLETED", "VALID_RETURN_SHIPMENT_PROOF", "ITEM_EMPTY_BOX", "ITEM_UNUSABLE", "ITEM_MISSING_QUANTITY_OR_QUALITY", "REFUND_AMOUNT_MISMATCH", "DUPLICATE_PAYMENT", "SELLER_PROMISED_REFUND_NOT_ISSUED", "CUSTOMER_CHARGED_INCORRECT_AMOUNT", "DUPLICATE_PAYMENT_BY_OTHER_MEANS", "GOODWILL_PAYOUT"^[0-9A-Z_]+$The justification for the adjudication outcome.
amount_refundedobjectThe amount that either the merchant or PayPal refunds the customer.
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.asset_refundedobjectThe asset that either the merchant or PayPal refunds the customer.
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.
adjudicationsarrayThe Teammate Adjudication details for the dispute.
itemsobjectThe Adjudication details for the dispute.
typerequiredstring"DENY_BUYER", "PAYOUT_TO_BUYER", "PAYOUT_TO_SELLER", "RECOVER_FROM_SELLER"^[0-9A-Z_]+$The type of adjudication.
adjudication_timerequiredstringppaas_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 adjudication was done, in Internet date and time format.
reasonstring"AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES", "BILLING_AGREEMENT_CHANGE_DISCLOSED", "BILLING_AGREEMENT_CHANGE_NOT_DISCLOSED", "BILLING_AGREEMENT_DATE_CHANGE_DISCLOSED", "BILLING_AGREEMENT_DATE_CHANGE_NOT_DISCLOSED", "BUYER_ATTEMPTED_RETURN", "BUYER_BILLED_ONLY_ONCE", "BUYER_CANCELLED_CASE", "BUYER_CANCELLED_SERVICE", "BUYER_FAILED_TO_DESCRIBE_ISSUE", "BUYER_HAS_POSSESSION_OF_THE_MERCHANDISE_OR_SERVICE", "BUYER_MADE_NO_ATTEMPT_TO_RESOLVE_WITH_SELLER", "BUYER_NOT_IN_POSSESSION_OF_ITEM_TO_RETURN", "BUYER_PROVIDED_CREDIT_RECEIPT", "BUYER_RECEIVED_DUPLICATE_REFUND", "CANCELLED_PER_TERMS_OF_BILLING_AGREEMENT", "CARD_NOT_STOLEN", "CARD_NOT_STOLEN_BEFORE_AUTH", "CUSTOMER_RECOGNIZES_TRANSACTION", "DECISION_BASED_ON_AVAILABLE_INFORMATION", "DELIVERY_AFTER_EXPECTED_DELIVERY_DATE", "DELIVERY_DUE_WITHIN_EXPECTED_DELIVERY_DATE", "DELIVERY_OR_SERVICE_REFUSED", "DOCUMENTATION_MATCHES_AMOUNT_CHARGED", "DOCUMENTATION_MATCHES_AMOUNT_IN_PAYPAL_ACCOUNT", "DUPLICATE_ADD_FUNDS", "EFFORTLESS_SELLER_PROTECTION", "IN_PERSON_DELIVERY", "INELIGIBLE_BUYER_PROTECTION_POLICY", "INELIGIBLE_SELLER_PROTECTION_POLICY", "INQUIRY_OFFER_ITEM_REPLACED", "INQUIRY_OFFER_PARTIAL_REFUND", "INQUIRY_OFFER_REFUND_WITH_ITEM_RETURN", "INQUIRY_OFFER_REFUND_WITH_REPLACEMENT", "INVALID_APPEAL_REASON", "INVALID_CHARGEBACK_SELLER_FAVOUR", "INVALID_DELIVERY_PROOF", "INVALID_DELIVERY_PROOF_SIGNATURE", "INVALID_DOCUMENTATION", "INVALID_PROOF_OF_SHIPMENT", "INVALID_REFUND_PROOF", "INVALID_RETURN_DELIVERY_NO_SIGNATURE_PROOF", "INVALID_RETURN_DELIVERY_PROOF", "INVALID_TRACKING", "ITEM_ALTERED_REPAIRED", "ITEM_NOT_AS_ADVERTISED", "ITEM_NOT_AS_DESCRIBED", "ITEM_NOT_DAMAGED", "ITEM_NOT_DELIVERED", "ITEM_NOT_RETURNED_TO_SELLER", "ITEM_NOT_SHIPPED", "ITEM_OF_DIFFERENT_QUALITY_OR_QUANTITY", "ITEM_OUT_OF_STOCK_AND_NOT_DELIVERED", "ITEM_RETURNED_TO_SELLER", "ITEM_SERVICE_MISREPRESENTED", "ITEM_SERVICE_NOT_MISREPRESENTED", "ITEM_SERVICE_RECEIVED_BY_BUYER", "ITEM_SOLD_AS_DESCRIBED", "ITEM_VALUE_UNAFFECTED", "MULTIPLE_APPEALS_WITH_SAME_REASON", "NO_DOCUMENTATION_FROM_BUYER", "NO_DOCUMENTATION_SUPPORTING_DUE_OF_CREDIT", "NO_PROOF_OF_DELIVERY", "NO_PROOF_OF_DELIVERY_INTANGIBLE", "NO_PROTECTION_FOR_DIGITAL_GOODS_SERVICE", "NO_RESPONSE_FROM_BUYER", "NO_RESPONSE_FROM_BUYER_FOR_ADDITIONAL_INFO_REQUEST", "NO_SELLER_RESPONSE", "NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST", "NO_VALID_SHIPMENT_PROOF", "NOT_A_BILLING_ERROR", "NOT_AN_UNAUTHORIZED_TRANSACTION", "NOT_DUPLICATE_FUNDS_ADDED_ONCE", "NOT_DUPLICATE_FUNDS_WITHDRAWN_ONCE", "NOT_SHIPPED_TO_CORRECT_ADDRESS", "PARTIAL_REFUND_ISSUED_FOR_MISSING_ITEMS", "PARTIAL_REFUND_OFFER_ACCEPTED", "PAYMENT_REVERSED_ALREADY", "POS_SUBMITTED_INSTEAD_OF_POD", "PREAUTH_INSTALLMENT_DUE", "PROOF_OF_BILLING_AFTER_CANCELLATION_ACCEPTED", "PROOF_OF_DUPLICATE_DENIED_OR_INSUFFICIENT", "PROOF_OF_INCORRECT_TRANSACTION_AMOUNT_ACCEPTED", "PROOF_OF_PAID_BY_OTHER_MEANS_NOT_SUBMITTED", "PROOF_OF_TRACKING_NOT_SUBMITTED", "PROTECTED_BY_PAYPAL", "REPRESENTED_BY_PAYPAL", "SELLER_ACCEPTED_MULTIPLE_PAYMENTS", "SELLER_AGREED_REFUND_WITHOUT_RETURN", "SELLER_AGREED_TO_ISSUE_CREDIT", "SELLER_ISSUED_CREDIT_TO_BUYER", "SELLER_ISSUED_REFUND", "SELLER_NOT_REACHABLE", "SELLER_RECEIVED_PAYMENT_TWICE_OR_FOR_REPLACEMENT", "SELLER_REFUSED_REFUND", "SELLER_REFUSED_RETURN", "SELLER_SURCHARGED_BUYER", "SERVICE_NOT_COMPLETED_AS_AGREED", "SHIPPING_COMPANY_WONT_SHIP", "TRACKING_PROOF_NOT_ENOUGH", "TRANSACTION_AUTHORIZED_BY_CARDHOLDER", "TRANSACTION_CANCELLED_AFTER_AUTHORIZATION_DATE", "TRANSACTION_CANCELLED_BEFORE_SHIPMENT_SERVICE_DATE", "TRANSACTION_MATCHES_BUYER_SPENDING_PATTERN", "TRANSACTION_PROCESSED_CORRECTLY", "TRUSTED_BUYER_PAYOUT", "UNUSED_SHIPPING_LABEL", "VALID_PROOF_OF_DELIVERY", "VALID_PROOF_OF_DELIVERY_WITH_SIGNATURE", "VALID_PROOF_OF_REFUND", "VALID_PROOF_SUPPORTING_CLAIM", "VALID_RETURN_DELIVERY_PROOF", "VALID_RETURN_DELIVERY_PROOF_WITH_SIGNATURE", "VALID_SHIPMENT_PROOF", "VALUE_AFFECTED_SIGNIFICANTLY", "PROTECTION_POLICY_APPLIES", "SNAD_DELAYED_FILING", "FUNDS_TRANSFERRED_TO_INCORRECT_RECIPIENT", "NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST", "IN_TRANSIT_BEYOND_TIMEFRAME_INVALID_PROOF_OF_SHIPMENT_OR_DELIVERY", "VALID_PROOF_SUPPORTING_CLAIM", "INVALID_EVIDENCE", "INVALID_PROOF_DELIVERED_TO_UNSPECIFIED_LOCATION", "INVALID_PROOF_DELIVERED_TO_INCORRECT_ADDRESS", "INVALID_PROOF_UNABLE_TO_TRACK", "SHIPPING_ADDRESS_NOT_PRESENT_IN_PROOF_OF_SHIPMENT_OR_DELIVERY", "INVALID_PROOF_ITEM_RETURNED_TO_SENDER", "DELIVERED_WITHOUT_REQUIRED_SIGNATURE_IN_PROOF_OF_DELIVERY", "NO_SHIPMENT_TRACKING_PROVIDED_IN_PROOF_OF_DELIVERY", "OTHER_ISSUE_WITH_PROOF_OF_SHIPMENT_OR_DELIVERY", "INSUFFICIENT_EVIDENCE_PROVIDED", "EVIDENCE_CANNOT_BE_LINKED_TO_TRANSACTION", "EVIDENCE_DOES_NOT_SHOW_FULFILLMENT_OR_CUSTOMER_BENEFIT", "SELLER_SHIPPED_OR_FULFILLED_BEYOND_ALLOWED_PERIOD", "ITEM_INELIGIBLE_FOR_SELLER_PROTECTION", "EVIDENCE_DOES_NOT_SHOW_SERVICE_COMPLETED", "VALID_RETURN_SHIPMENT_PROOF", "ITEM_EMPTY_BOX", "ITEM_UNUSABLE", "ITEM_MISSING_QUANTITY_OR_QUALITY", "REFUND_AMOUNT_MISMATCH", "DUPLICATE_PAYMENT", "SELLER_PROMISED_REFUND_NOT_ISSUED", "CUSTOMER_CHARGED_INCORRECT_AMOUNT", "DUPLICATE_PAYMENT_BY_OTHER_MEANS", "GOODWILL_PAYOUT"^[0-9A-Z_]+$The reason for the adjudication type.
dispute_life_cycle_stagestring"INQUIRY", "CHARGEBACK", "PRE_ARBITRATION", "ARBITRATION"^[0-9A-Z_]+$The dispute life cycle stage during the adjudication.
money_movementsarrayDEPRECATED The Money movement details for the dispute.
itemsobjectThe Money movement details with party.
affected_partystring"SELLER", "BUYER", "PAYMENT_PROCESSOR"^[0-9A-Z_]+$The affected party in the money movement.
amountobjectThe amount transferred as part of the money movement.
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.assetobjectThe asset transferred as part of the money movement.
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.
initiated_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 money movement was initiated, in Internet date and time format.
typestring"DEBIT", "CREDIT"^[0-9A-Z_]+$The type of the money movement.
reasonstring"DISPUTE_SETTLEMENT_FEE", "DISPUTE_SETTLEMENT", "DISPUTE_FEE", "CHARGEBACK_FEE"^[0-9A-Z_]+$The reason for the money movement.
fund_movementsarrayThe movements of fund due to the dispute.
itemsobjectThis section contains the details about the fund movement of the parties ,time , direction and the reason for it.
partystring"SELLER", "BUYER", "PAYMENT_PROCESSOR"^[0-9A-Z_]+$The affected party in the money movement.
amountobjectThe amount transferred as part of the money movement.
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.assetobjectThe asset transferred as part of the money movement.
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.
initiated_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 money movement was initiated, in Internet date and time format.
typestring"DEBIT", "CREDIT"^[0-9A-Z_]+$The type of the money movement.
reasonstring"REVERSED_TRANSACTION_FEE", "DISPUTE_SETTLEMENT", "DISPUTE_FEE", "CHARGEBACK_FEE"^[0-9A-Z_]+$The reason for the fund movement.
dispute_life_cycle_stagestring"INQUIRY", "CHARGEBACK", "PRE_ARBITRATION", "ARBITRATION"^[0-9A-Z_]+$The stage in the dispute lifecycle.
dispute_channelstring"INTERNAL", "EXTERNAL", "ALERT"^[A-Z0-9_]+$The channel where the customer created the dispute.
messagesarrayAn array of customer- or merchant-posted messages for the dispute.
itemsobjectA customer- or merchant-posted message for the dispute.
posted_bystring"BUYER", "SELLER", "ARBITER"^[0-9A-Z_]+$Indicates whether the customer, merchant, or dispute arbiter posted the message.
time_postedstringppaas_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 message was posted, in Internet date and time format.
contentstring^(.|\r?\n)*$The message text.
documentsarrayAn array of metadata for the documents which contains any additional info about the message posted.
itemsobjectAn uploaded document as a binary object that supports a dispute.
namestring^[A-Za-z0-9-_,\s]+[.]{1}[A-Za-z]+$The document name.
urlstringuriThe downloadable URL for the document for which the client has access.
Note: Document download may require some configuration setup and available as a limited release at this time. For more information, reach out to your PayPal account manager..
extensionsobjectThe extended properties for the dispute. Includes additional information for a dispute category, such as billing disputes, the original transaction ID, and the correct amount.
merchant_contactedbooleanIndicates that the merchant was contacted.
merchant_contacted_outcomestring"NO_RESPONSE", "FIXED", "RESPONDED", "NOT_FIXED"^[0-9A-Z_]+$The outcome when the customer has contacted the merchant.
merchant_contacted_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 merchant was contacted.
merchant_contacted_modestring"WEBSITE", "PHONE", "EMAIL", "WRITTEN", "IN_PERSON"^[0-9A-Z_]+$The method used to contact the merchant.
buyer_contacted_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 buyer contacted the partner to file a dispute, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
buyer_contacted_channelstring^.*$The channel through which the buyer contacted the partner to file a dispute. Partners that allow buyers to create dispute from multiple channels can use this field to help identify which channel was used for each individual dispute.
billing_dispute_propertiesobjectThe billing issue details.
duplicate_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.
merchandize_dispute_propertiesobjectThe customer-provided merchandise issue details for the dispute.
issue_typestring"PRODUCT", "SERVICE"^[0-9A-Z_]+$The issue type.
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.
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.
return_shipping_addressobjectThe return address for the item. Required when the customer must return an item to the merchant for the MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED dispute reason.
address_line_1stringThe first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
address_line_2stringThe second line of the address. For example, suite or apartment number.
address_line_3stringThe third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
admin_area_4stringThe neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3stringA sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
admin_area_2stringA city, town, or village. Smaller than admin_area_level_1.
admin_area_1stringThe highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobjectThe non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
street_numberstringThe street number.
street_namestringThe street name. Just Drury in Drury Lane.
street_typestringThe street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestringThe delivery service. Post office box, bag number, or post office name.
building_namestringA named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
sub_buildingstringThe first-order entity below a named building or location that represents the sub-premises. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
reported_sourcestring"EMAIL", "WEB", "CHAT", "IVR", "PHONE", "MOBILE_APP", "MOBILE_WEB", "API"^[A-Z0-9_]+$The dispute source through which customer initiated the dispute.
evidencesarrayAn array of evidence documents.
itemsobjectA 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.
evidence_typestring"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", "CANCELLATION_DETAILS", "MERCHANT_CONTACT_DETAILS", "ITEM_DETAILS", "CORRECT_RECIPIENT_INFORMATION", "EXPLANATION_OF_FUNDS_NOT_DELIVERED", "CONFIRMATION_OF_RECALL", "COMMUNICATION_WITH_THE_SENDER", "PAYMENT_REASON", "PROOF_OF_EXPECTED_DELIVERY_DATE", "DELIVERY_DELAY_COMMUNICATION", "ADDITIONAL_SCAM_DETAILS", "REASON_FOR_LATE_OPENING", "COMMUNICATION_WITH_THE_RECIPIENT", "EFFORTS_TO_VERIFY_RECIPIENT"^[A-Z0-9_]+$The evidence type.
evidence_infoobjectThe evidence-related information.
tracking_infoarrayAn array of relevant tracking information for the transaction involved in this dispute.
itemsobjectThe tracking information.
carrier_namerequiredstring"UPS", "USPS", "FEDEX", "AIRBORNE_EXPRESS", "DHL", "AIRSURE", "ROYAL_MAIL", "PARCELFORCE", "SWIFTAIR", "OTHER", "UK_PARCELFORCE", "UK_ROYALMAIL_SPECIAL", "UK_ROYALMAIL_RECORDED", "UK_ROYALMAIL_INT_SIGNED", "UK_ROYALMAIL_AIRSURE", "UK_UPS", "UK_FEDEX", "UK_AIRBORNE_EXPRESS", "UK_DHL", "UK_OTHER", "UK_CANNOT_PROV_TRACK", "UK_CANNOT_PROVIDE_TRACKING", "CA_CANADA_POST", "CA_PUROLATOR", "CA_CANPAR", "CA_LOOMIS", "CA_TNT", "TNT", "CA_OTHER", "CA_CANNOT_PROV_TRACK", "DE_DP_DHL_WITHIN_EUROPE", "DE_DP_DHL_T_AND_T_EXPRESS", "DE_DHL_DP_INTL_SHIPMENTS", "CA_CANNOT_PROVIDE_TRACKING", "DE_GLS", "DE_DPD_DELISTACK", "DE_HERMES", "DE_UPS", "DE_FEDEX", "DE_TNT", "DE_OTHER", "FR_CHRONOPOST", "FR_COLIPOSTE", "FR_DHL", "FR_UPS", "FR_FEDEX", "FR_TNT", "FR_GLS", "FR_OTHER", "IT_POSTE_ITALIA", "IT_DHL", "IT_UPS", "IT_FEDEX", "IT_TNT", "IT_GLS", "IT_OTHER", "AU_AUSTRALIA_POST_EP_PLAT", "AU_AUSTRALIA_POST_EPARCEL", "AU_AUSTRALIA_POST_EMS", "AU_DHL", "AU_STAR_TRACK_EXPRESS", "AU_UPS", "AU_FEDEX", "AU_TNT", "AU_TOLL_IPEC", "AU_OTHER", "FR_SUIVI", "IT_EBOOST_SDA", "ES_CORREOS_DE_ESPANA", "ES_DHL", "ES_UPS", "ES_FEDEX", "ES_TNT", "ES_OTHER", "AT_AUSTRIAN_POST_EMS", "AT_AUSTRIAN_POST_PPRIME", "BE_CHRONOPOST", "BE_TAXIPOST", "CH_SWISS_POST_EXPRES", "CH_SWISS_POST_PRIORITY", "CN_CHINA_POST", "HK_HONGKONG_POST", "IE_AN_POST_SDS_EMS", "IE_AN_POST_SDS_PRIORITY", "IE_AN_POST_REGISTERED", "IE_AN_POST_SWIFTPOST", "IN_INDIAPOST", "JP_JAPANPOST", "KR_KOREA_POST", "NL_TPG", "SG_SINGPOST", "TW_CHUNGHWA_POST", "CN_CHINA_POST_EMS", "CN_FEDEX", "CN_TNT", "CN_UPS", "CN_OTHER", "NL_TNT", "NL_DHL", "NL_UPS", "NL_FEDEX", "NL_KIALA", "BE_KIALA", "PL_POCZTA_POLSKA", "PL_POCZTEX", "PL_GLS", "PL_MASTERLINK", "PL_TNT", "PL_DHL", "PL_UPS", "PL_FEDEX", "JP_SAGAWA_KYUU_BIN", "JP_NITTSU_PELICAN_BIN", "JP_KURO_NEKO_YAMATO_UNYUU", "JP_TNT", "JP_DHL", "JP_UPS", "JP_FEDEX", "NL_PICKUP", "NL_INTANGIBLE", "NL_ABC_MAIL", "HK_FOUR_PX_EXPRESS", "HK_FLYT_EXPRESS", "US_ASCENDIA", "US_ENSENDA", "US_GLOBEGISTICS", "US_ONTRAC", "RRDONNELLEY", "ASENDIA_UK", "UK_COLLECTPLUS", "UK_DPD", "UK_HERMESWORLD", "UK_INTERLINK_EXPRESS", "UK_TNT", "UK_UK_MAIL", "UK_YODEL", "BUYLOGIC", "CN_EMS", "CHINA_POST", "CNEXPS", "CPACKET", "CUCKOOEXPRESS", "CN_EC", "CN_EMPS", "DE_ASENDIA", "UK_DELTEC", "DE_DEUTSCHE", "DE_DPD", "RABEN_GROUP", "GLOBAL_TNT", "ADSONE", "AU_AU_POST", "BONDSCOURIERS", "COURIERS_PLEASE", "DTDC_AU", "AU_FASTWAY", "HUNTER_EXPRESS", "SENDLE", "AUS_TOLL", "TOLL", "UBI_LOGISTICS", "OMNIPARCEL", "QUANTIUM", "CN_SF_EXPRESS", "SEKOLOGISTICS", "HK_TAQBIN", "GB_APC", "CA_CANPAR_COURIER", "GLOBAL_ESTES", "CA_GREYHOUND", "PUROLATOR", "US_RL", "IT_BRT", "DMM_NETWORK", "IT_FERCAM", "HERMES_IT", "IT_POSTE_ITALIANE", "IT_SDA", "IT_SGT", "GLOBAL_SKYNET", "FR_BERT", "FR_COLIS", "FR_GEODIS", "FR_LAPOSTE", "FR_TELIWAY", "DPD_POLAND", "INPOST_PACZKOMATY", "POL_POCZTA", "POL_SIODEMKA", "ESP_CORREOS", "ES_CORREOS", "ESP_NACEX", "ESP_ASM", "ESP_REDUR", "CBL_LOGISTICA", "EKART", "IND_DELHIVERY", "IND_BLUEDART", "IND_DTDC", "IND_PROFESSIONAL_COURIERS", "IND_REDEXPRESS", "IND_XPRESSBEES", "IND_DOTZOT", "THA_KERRY", "SENDIT", "ACOMMERCE", "NINJAVAN_THAI", "NIM_EXPRESS", "THA_THAILAND_POST", "THA_DYNAMIC_LOGISTICS", "ALPHAFAST", "FASTRAK_TH", "EPARCEL_KR", "CJ_KOREA_THAI", "RINCOS", "KOR_KOREA_POST", "KOR_CJ", "KOR_ECARGO", "SREKOREA", "ROCKETPARCEL", "BG_BULGARIAN_POST", "JPN_JAPAN_POST", "JPN_YAMATO", "JPN_SAGAWA", "TUR_PTT", "AUT_AUSTRIAN_POST", "AU_AUSTRIAN_POST", "RUSSIAN_POST", "BEL_DHL", "FR_MONDIAL", "EU_BPOST", "LANDMARK_GLOBAL", "IDN_POS", "IDN_POS_INT", "IDN_JNE", "IDN_PANDU", "RPX", "IDN_TIKI", "IDN_LION_PARCEL", "NINJAVAN_ID", "IDN_WAHANA", "IDN_FIRST_LOGISTICS", "UK_AN_POST", "DPD", "UK_FASTWAY", "UK_NIGHTLINE", "WISELOADS", "GR_ELTA", "GRC_ACS", "GR_GENIKI", "NINJAVAN_PHILIPPINES", "PHL_XEND_EXPRESS", "PHL_LBC", "PHL_JAMEXPRESS", "PHL_AIRSPEED", "PHL_RAF", "DIRECTLOG", "BRA_CORREIOS", "NLD_DHL", "NLD_POSTNL", "NLD_GLS", "NLD_TRANSMISSION", "CORREOS_DE_MEXICO", "MEX_ESTAFETA", "MEX_SENDA", "MEX_REDPACK", "MEX_AEROFLASH", "NATIONWIDE_MY", "MYS_MYS_POST", "MYS_TAQBIN", "MYS_SKYNET", "MYS_CITYLINK", "MYS_AIRPAK", "NINJAVAN_MY", "KANGAROO_MY", "VNM_VIETNAM_POST", "VNPOST_EMS", "PRT_INT_SEUR", "PRT_CTT", "PRT_CHRONOPOST", "PRT_SEUR", "ADICIONAL", "LTU_LIETUVOS", "DPEX", "LWE_HK", "SG_SG_POST", "SG_TAQBIN", "SG_NINJAVAN", "SG_ZALORA", "JET_SHIP", "SG_PARCELPOST", "CHE_SWISS_POST", "ASENDIA_HK", "HUN_MAGYAR", "POSTNORD_LOGISTICS", "SWE_DIRECTLINK", "SWE_POSTNORD", "SWE_DB", "CZE_CESKA", "NZ_NZ_POST", "NZ_COURIER_POST", "FASTWAY_NZ", "TW_TAIWAN_POST", "SPREADEL", "ARE_EMIRATES_POST", "AXL", "CYP_CYPRUS_POST", "HRV_HRVATSKA", "NOR_POSTEN", "RAM", "THECOURIERGUY", "ZA_FASTWAY", "DPE_EXPRESS", "POSTI", "MATKAHUOLTO", "GLOBAL_DHL", "ARG_CORREO", "ARG_OCA", "POST_SERBIA", "BH_POSTA", "CORREOS_CHILE", "APR_72", "CORREOS_DE_COSTA_RICA", "POSTUR_IS", "SPEEDEXCOURIER", "ROU_POSTA", "UKR_NOVA", "UKR_POSHTA", "NGA_NIPOST", "NG_COURIERPLUS", "ESHOPWORLD", "WEBINTERPRET", "HERMES", "ABC_MAIL", "ARAMEX", "YANWEN", "INTERNATIONAL_BRIDGE", "SFC_LOGISTICS", "BQC_EXPRESS", "ONE_WORLD", "IT_REGISTER_MAIL", "WINIT", "CONTINENTAL", "EFS", "PANTOS", "RELAIS_COLIS", "US_DHL_EXPRESS", "US_DHL_PARCEL", "US_DHL_ECOMMERCE", "US_DHL_GLOBALFORWARDING", "UK_DHL_EXPRESS", "UK_DHL_PARCEL", "UK_DHL_GLOBALFORWARDING", "CN_DHL_EXPRESS", "CN_DHL_ECOMMERCE", "CN_DHL_GLOBALFORWARDING", "DE_DHL_EXPRESS", "DE_DHL_PARCEL", "DE_DHL_PACKET", "DE_DHL_ECOMMERCE", "DE_DHL_GLOBALFORWARDING", "DE_DHL_DEUTSCHEPOST", "AU_DHL_EXPRESS", "AU_DHL_ECOMMERCE", "AU_DHL_GLOBALFORWARDING", "HK_DHL_EXPRESS", "HK_DHL_ECOMMERCE", "HK_DHL_GLOBALFORWARDING", "CA_DHL_EXPRESS", "CA_DHL_ECOMMERCE", "CA_DHL_GLOBALFORWARDING", "IT_DHL_EXPRESS", "IT_DHL_ECOMMERCE", "IT_DHL_GLOBALFORWARDING", "FR_DHL_EXPRESS", "FR_DHL_PARCEL", "FR_DHL_GLOBALFORWARDING", "PL_DHL_EXPRESS", "PL_DHL_PARCEL", "PL_DHL_GLOBALFORWARDING", "ABC_PACKAGE", "AN_POST", "APC_OVERNIGHT", "ASM_ES", "AUPOST_CN", "ACOMMMERCE", "ADICIONAL_PT", "AIR_21", "AIRBORNE_EXPRESS_UK", "AIRPAK_MY", "AIRSPEED", "ASENDIA_DE", "ASENDIA_US", "AUSTRALIA_POST", "TOLL_AU", "AUSTRIAN_POST_EXPRESS", "AUSTRIAN_POST", "B_TWO_C_EUROPE", "BERT", "BPOST", "BRT_IT", "BLUEDART", "BONDS_COURIERS", "BPOST_INT", "BULGARIAN_POST", "CJ_LOGISTICS", "CJ_INT_MY", "CJ_MY", "CJ_TH", "CANADA_POST", "CANPAR", "CESKA_CZ", "CHRONOPOST_FR", "CHRONOPOST_PT", "CHUNGHWA_POST", "CITYLINK_MY", "COLIPOSTE", "COLIS", "COLLECTPLUS", "CORREOS_AG", "CORREOS_BR", "CORREOS_CL", "CORREOS_CR", "CORREOS_MX", "CORREOS_ES", "CORREOS_EXPRESS", "COURIERPLUS", "COURIER_POST", "CYPRUS_POST_CYP", "DBSCHENKER_SE", "DHL_ES", "DHL_ACTIVE_TRACING", "DHL_AU", "DHL_BENELUX", "DHL_DEUTSCHE_POST", "DHL_FR", "DHL_GLOBAL_ECOMMERCE", "DHL_HK", "DHL_IT", "DHL_JP", "DHL_NL", "DHL_PACKET", "DHL_PARCEL_NL", "DHL_PARCEL_ES", "DHL_PL", "DHL_SG", "DHL_UK", "DHL_GLOBAL_MAIL_ASIA", "DHL_GLOBAL_MAIL", "DHL_AT", "DPD_DELISTRACK", "DPD_FR", "DPD_DE", "DPD_HK", "DPD_IR", "DPD_LOCAL_REF", "DPD_LOCAL", "DPD_PL", "DPD_RO", "DPD_RU", "DPD_UK", "DTDC_EXPRESS", "DTDC_IN", "DAWN_WING", "DELHIVERY_IN", "DELTEC_DE", "DELTEC_UK", "DEUTSCHE_DE", "DIRECTLINK_SE", "DIRECTLOG_BR", "DOTZOT", "EC_CN", "ELTA_GR", "EMPS_CN", "EMS_CN", "ECARGO", "EMIRATES_POST", "ENSENDA", "ESTAFETA", "ESTES", "FERCAM_IT", "FLYT_EXPRESS", "FASTRACK", "FASTWAY_US", "FASTWAY_ZA", "FASTWAY_UK", "FASTWAY_AU", "FIRST_LOGISITCS", "FOUR_PX_EXPRESS", "GEODIS", "GLS_CZ", "GLS_FR", "GLS_DE", "GLS_IT", "GLS_NL", "GLS_ES", "GLS", "ACS_GR", "GENIKI_GR", "GLOBEGISTICS", "GREYHOUND", "HERMES_DE", "HERMESWORLD_UK", "HK_POST", "HRVATSKA_HR", "HUAHAN_EXPRESS", "IMX", "ITIS", "INDIA_POST", "INTERLINK", "INT_SEUR", "INT_SUER", "ISRAEL_POST", "JNE_IDN", "JAMEXPRESS_PH", "JAPAN_POST", "JP_POST", "JETSHIP_MY", "JETSHIP_SG", "KERRY_EXPRESS_VN", "KERRY_EXPRESS_HK", "KERRY_EXPRESS_TH", "KIALA", "KOREA_POST", "CJ_KR", "LAPOSTE", "LBC_PH", "LIETUVOS_LT", "LION_PARCEL", "LOGISTICSWORLDWIDE_HK", "LOGISTICSWORLDWIDE_KR", "LOGISTICSWORLDWIDE_MY", "LOOMIS", "MONDIAL", "MAGYAR_HU", "MALAYSIA_POST", "MASTERLINK", "AEROFLASH", "REDPACK", "SENDA_MX", "MONDIAL_BE", "MYHERMES", "NACEX_ES", "NATIONWIDE", "NZ_POST", "NIPOST_NG", "NIGHTLINE_UK", "NINJAVAN_PH", "NINJAVAN_SG", "NOVA_POSHTA_INT", "NOVA_POSHTA", "OCA_AR", "ONTRAC", "PTT_POST", "PANDU", "PARCELPOST_SG", "POCZTA_POLSKA", "POCZTEX", "CTT_PT", "SEUR_PT", "POS_ID", "POS_INT", "POSTNL_INT_3_S", "POSTNL", "POSTNL_INT", "POSTNORD_LOGISTICS_DK", "POSTNORD_LOGISTICS_SE", "POSTNORD_LOGISTICS_GLOBAL", "POSTA_RO", "POSTE_ITALIANE", "POSTEN_NORGE", "PROFESSIONAL_COURIERS", "RAF_PH", "RL_US", "RPD_2_MAN", "RPX_ID", "REDEXPRESS", "REDUR_ES", "REGISTER_MAIL_IT", "RELAIS_COLIS_FR", "ROCKET_PARCEL", "SDA_IT", "SF_EXPRESS", "SFC_EXPRESS", "SGT_IT", "SRE_KOREA", "SAGAWA", "SAGAWA_JP", "POST_SERBIA_CS", "SINGPOST", "SIODEMKA", "SKYNET_WORLDWIDE", "SKYNET_MY", "SKYNET_UAE", "SKYNET_UK", "SEUR_ES", "STARTRACK_EXPRESS", "STARTRACK", "SWISS_POST", "TNT_AU", "TNT_CN", "TNT_CLICK_IT", "TNT_FR", "TNT_DE", "TNT_IT", "TNT_JP", "TNT_NL", "TNT_PL", "TNT_ES", "TNT_UK", "TPG", "TAIWAN_POST_TW", "TAQBIN_HK", "TAQBIN_MY", "TAQBIN_SG", "TAXIPOST", "TELIWAY", "THAILAND_POST", "THE_COURIER_GUY", "TIKI_ID", "TOLL_IPEC", "TWO_GO", "TRANSMISSION", "UK_MAIL", "UPS_MI", "VIETNAM_POST", "WAHANA_ID", "XEND_EXPRESS_PH", "XPRESSBEES", "YAMATO", "YANWEN_CN", "YODEL", "UPS_CANADA", "UPS_MAIL_INNOVATIONS", "DE_DELTEC", "DE_INTERNATIONALSEUR", "FR_DPD", "FR_IMX", "IT_IMX", "AU_DTDC", "AU_SENDLE", "AU_SKYNET", "ES_GLS", "ES_INTERNATIONALSEUR", "ES_IMX", "CN_HUAHANEXPRESS", "LOCAL_PICKUP", "HK_DPEX", "HK_KERRYEXPRESS", "HK_LOGISTICSWORLDWIDEEXPRESS", "HK_RPX", "HK_SPREADEL", "IN_SPREADEL", "TH_CJ", "KR_LOGISTICSWORLDWIDE", "AT_DHL", "BE_IMX", "MY_LOGISTICSWORLDWIDE", "MY_JETSHIP", "SG_DHL", "SG_SPREADEL", "POSTAROMANA", "US_PUROLATOR", "US_FASTWAY", "CHRONOPOST", "CORREOS_DE_ESPANA", "DEUTSCHE_POST_DHL", "EBOOST_SDA", "HONGKONG_POST", "INTANGIBLE_DIGITAL_SERVICES", "LA_POSTE", "LA_POSTE_SUIVI", "NEKO_YAMATO_UNYUU", "NITTSU_PELICAN_BIN", "POSTE_ITALIA", "SAGAWA_KYUU_BIN", "STAR_TRACK_EXPRESS", "US_DTDC", "US_STARTRACK", "ISR_ISRAEL_POST", "BE_MONDIAL", "B_2_CEUROPE", "PHL_2_GO", "PHL_AIR_21", "PT_SPANISH_SEUR", "ES_SPANISH_SEUR", "SG_DPEX", "CH_IMX", "DHLG", "RUSTON", "MIKROPAKKET", "XPOST", "PAN_ASIA", "PARCELONE", "SPEEDEE", "VENIPAK", "CROSHOT", "SHREENANDANCOURIER", "EPST_GLBL", "NEWGISTICS", "POST_SLOVENIA", "JERSEY_POST", "WMG", "BOMBINOEXP", "XQ_EXPRESS", "FURDECO", "LEGION_EXPRESS", "YDH_EXPRESS", "LHT_EXPRESS", "SOUTH_AFRICAN_POST_OFFICE", "GRUPO", "SPOTON", "DIMERCO", "INTERPARCEL_UK", "ABCUSTOM", "IND_DELIVREE", "GLOBAL_ABF", "CN_BESTEXPRESS", "DX_SFTP", "PICKUPP_MYS", "XPERT_DELIVERY", "FMX", "HELLMANN", "DHL_REFR", "DHL_HK", "SHIP_IT_ASIA", "KERRY_ECOMMERCE", "GOJEK", "FRETERAPIDO", "YODEL_INTNL", "CFL_LOGISTICS", "PITNEY_BOWES", "ZA_SPECIALISED_FREIGHT", "JANCO", "XPRESSEN_DK", "YTO", "RPD2MAN", "SEUR_SP_API", "DELIVERYONTIME", "WISE_EXPRESS", "JINSUNG", "JTEXPRESS_VN", "CHUKOU1", "TRANS_KARGO", "FEDEX_INTL_MLSERV", "SWISHIP_DE", "IVOY_WEBHOOK", "AIRMEE_WEBHOOK", "VAMOX", "FIRSTMILE", "AMS_GRP", "FASTWAY_IR", "HH_EXP", "HRPARCEL", "MYS_MYPOST_ONLINE", "GESWL", "BLUESTAR", "TIPSA", "CDEK_TR", "KGMHUB", "INTEXPRESS", "DESCARTES", "OVERSE_EXP", "ONECLICK", "ROADRUNNER_FREIGHT", "GLS_CROTIA", "TOURLINE", "MRW_FTP", "BH_WORLDWIDE", "BLUEX", "DYLT", "OCS", "YINGNUO_LOGISTICS", "SIN_GLBL", "TUFFNELLS_REFERENCE", "CJPACKET", "MILKMAN", "FIEGE_NL", "ASIGNA", "ONEWORLDEXPRESS", "LTIANEXP", "KWE_GLOBAL", "CTC_EXPRESS", "LAO_POST", "EU_IMX", "GLS_SLOV", "AMAZON", "MORE_LINK", "JX", "MYS_EMS", "EASY_MAIL", "ADUIEPYLE", "GB_PANTHER", "SG_DETRACK", "EXPRESSSALE", "DICOM", "MATDESPATCH", "TRUNKRS_WEBHOOK", "WESTBANK_COURIER", "MBW", "KHM_CAMBODIA_POST", "FEDEX_CROSSBORDER", "JANIO", "SINOTRANS", "BRT_IT_PARCELID", "A1POST", "DHL_SUPPLY_CHAIN", "TAZMANIAN_FREIGHT", "TOPYOU", "PALEXPRESS", "SAIA_FREIGHT", "CN_WEDO", "FULFILLME", "SG_QXPRESS", "UPS_REFERENCE", "NHANS_SOLUTIONS", "CARIBOU", "LOCUS_WEBHOOK", "DSV", "CN_GOFLY", "COORDINADORA", "P2P_TRC", "ANDREANI", "DIRECTPARCELS", "DOORA", "FEDEX_POLAND", "INTERPARCEL_NZ", "XDP_UK_REFERENCE", "ETOMARS", "CN_JCEX", "IND_ECOM", "FAR_INTERNATIONAL", "ESP_ENVIALIA", "IDEXPRESS", "GANGBAO", "SMSA_EXPRESS", "NEWAY", "DEX_I", "DESIGNERTRANSPORT_WEBHOOK", "BUDBEE_WEBHOOK", "GLS_SLOVEN", "PARCELLED_IN", "COPA_COURIER", "GSI_EXPRESS", "CON_WAY", "BROUWER_TRANSPORT", "TOLL_NZ", "CPEX", "ECHO", "FEDEX_FR", "XDE_WEBHOOK", "TOLOS", "BORDEREXPRESS", "GIAO_HANG", "MAILPLUS_JPN", "GEODIS_ESPACE", "TNT_UK_REFR", "DOORDASH_WEBHOOK", "KEC", "CJ_HK_INTERNATIONAL", "HELTHJEM", "ZA_COURIERIT", "SFB2C", "FREIGHTQUOTE", "FR_EXAPAQ", "LANDMARK_GLOBAL_REFERENCE", "PARCEL2GO", "DELNEXT", "TCK_EXPRESS", "ENDEAVOUR_DELIVERY", "NANJINGWOYUAN", "HEPPNER_FR", "PICKRR", "FONSEN", "APC_OVERNIGHT_CONNUM", "STAR_TRACK_NEXT_FLIGHT", "UPS_FREIGHT", "DAJIN", "POSTA_PLUS", "CEVA", "ORANGE_DS", "ANSERX", "JS_EXPRESS", "PADTF", "GAC", "EZSHIP", "GEIS", "SYPOST", "AMAZON_SHIP_MCF", "SF_EX", "YUSEN", "ESP_MRW", "BRING", "PAGO", "AO_COURIER", "GBA", "DIAMOND_EUROGISTICS", "NEWEGGEXPRESS", "LALAMOVE", "SPEEDCOURIERS_GR", "CORPORATECOURIERS_WEBHOOK", "FORRUN", "PICKUP", "BOND", "ECMS", "INTELIPOST", "SK_POSTA", "FLASHEXPRESS", "FETCHR_WEBHOOK", "CN_STO", "SEKO_SFTP", "THEDELIVERYGROUP", "CELLO_SQUARE", "HOME_DELIVERY_SOLUTIONS", "DPD_HGRY", "KERRYTTC_VN", "TARRIVE", "JOYING_BOX", "COLLIVERY", "TOTAL_EXPRESS", "ZJS_EXPRESS", "STARKEN", "MAINFREIGHT", "IND_FIRSTFLIGHT", "BE_BPOST", "DEMANDSHIP", "CN_DPEX", "ACSWORLDWIDE", "LOGISTERS", "GOGLOBALPOST", "AMSTAN", "OKAYPARCEL", "I_DIKA", "ENVIALIA_REFERENCE", "PAACK_WEBHOOK", "GRAB_WEBHOOK", "PARCELPOINT", "ICUMULUS", "FDSEXPRESS", "DAIGLOBALTRACK", "CNDEXPRESS", "GLOBAL_IPARCEL", "AMAZON_FBA_SWISHIP", "WYNGS", "YURTICI_KARGO", "CN_PAYPAL_PACKAGE", "PARCEL_2_POST", "ZYLLEM", "VIA_EXPRESS", "WIZMO", "TIGFREIGHT", "PIL_LOGISTICS", "ZTO_EXPRESS", "HEPPNER", "GENERAL_OVERNIGHT", "HAPPY2POINT", "ARCO_SPEDIZIONI", "CHITCHATS", "IML", "SMOOTH", "INTEL_VALLEY", "CLE_LOGISTICS", "FIEGE", "MX_CARGO", "ZIINGFINALMILE", "TCS", "DAYTON_FREIGHT", "ROADBULL", "YODEL_DIR", "STONE3PL", "PARCELPAL_WEBHOOK", "DHL_ECOMERCE_ASA", "SIMPLYPOST", "KY_EXPRESS", "SHENZHEN", "UC_EXPRE", "US_LASERSHIP", "DIDADI", "DYNALOGIC", "DBSCHENKER_B2B", "MXE", "PFCEXPRESS", "WHISTL", "CAE_DELIVERS", "WEPOST", "ALLIEDEXPRESS", "SHIPPIT", "DDEXPRESS", "ARAMEX_AU", "TFM", "BNEED", "M_XPRESS", "HK_TGX", "LATVIJAS_PASTS", "HDB_BOX", "VIAEUROPE", "CORREO_UY", "CLEVY_LINKS", "IBEONE", "J_NET", "RCL", "6LS", "CGS_EXPRESS", "BLR_BELPOST", "BIRDSYSTEM", "DOBROPOST", "SAP_EXPRESS", "WEASHIP", "SONICTL", "KWT", "AFLLOG_FTP", "IND_SAFEEXPRESS", "TOPHATTEREXPRESS", "SEINO", "MGLOBAL", "SZENDEX", "AVERITT", "DBSCHENKER_SV", "LEADER", "AO_DEUTSCHLAND", "2EBOX", "EU_FLEET_SOLUTIONS", "SG_SPEEDPOST", "PCFCORP", "AERONET", "LINKBRIDGE", "DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET", "PRIMAMULTICIPTA", "ISR_POST_DOMESTIC", "COUREX", "ZAJIL_EXPRESS", "BESTWAYPARCEL", "COLLECTCO", "AEX", "JTEXPRESS", "FEDEX_UK", "USHIP", "ROUTIFIC_WEBHOOK", "GLOBAL_EXPRESS", "BRT_IT_SENDER_REF", "GLOBAVEND", "PIXSELL", "SHIPTOR", "CDEK", "VNM_VIETTELPOST", "PHL_AIR21", "PALLET_NETWORK", "CJ_CENTURY", "UK_XDP", "GSO", "VIWO", "SKYBOX", "PAPER_EXPRESS", "KERRYTJ", "NTLOGISTICS_VN", "SDH_SCM", "PALLETWAYS", "NOX_NACHTEXPRESS", "ZINC", "DPE_SOUTH_AFRC", "LOGISTIKA", "CELERITAS", "PRESSIODE", "SHREE_MARUTI", "PARCELINKLOGISTICS", "EFEX", "LOTTE", "LONESTAR", "GB_NORSK", "APRISAEXPRESS", "BEL_RS", "OSM_WORLDWIDE", "SAILPOST", "MAILAMERICAS", "WESTGATE_GL", "DTD_EXPR", "ALFATREX", "THABIT_LOGISTICS", "PROMEDDELIVERY", "PAQUETEXPRESS", "NEWZEALAND_COURIERS", "LIEFERY", "JOOM_LOGIS", "STRECK_TRANSPORT", "HCT_LOGISTICS", "ZA_FASTWAY", "CARRY_FLAP", "PONY_EXPRESS", "US_OLD_DOMINION", "ANICAM_BOX", "ALWAYS_EXPRESS", "WANBEXPRESS", "AUS_STARTRACK", "GBS_BROKER", "STALLIONEXPRESS", "RAIDEREX", "ALLJOY", "SHOPFANS", "KYUNGDONG_PARCEL", "CHAMPION_LOGISTICS", "PICKUPP_SGP", "DEALERSEND", "MORNING_EXPRESS", "NACEX", "THENILE_WEBHOOK", "JOCOM", "HOLISOL", "LBCEXPRESS_FTP", "CSE", "TFORCE_FINALMILE", "KURASI", "GEMWORLDWIDE", "SHIP_GATE", "USF_REDDAWAY", "SHIPTER", "NATIONAL_SAMEDAY", "APG", "CN_BOXC", "YUNEXPRESS", "INTEGRA2_FTP", "CAINIAO", "ECOSCOOTING", "DMS_MATRIX", "MAINWAY", "ASENDIA_USA", "PAPERFLY", "HOUNDEXPRESS", "3JMSLOGISTICS", "EP_BOX", "BOX_BERRY", "LICCARDI_EXPRESS", "PLUS_LOG_UK", "FULFILLA", "SKY_POSTAL", "ASE", "CNWANGTONG", "PITTOHIO", "MAIL_PLUS", "XPO_LOGISTICS", "WNDIRECT", "CLOUDWISH_ASIA", "ZELERIS", "MARA_XPRESS", "GIO_EXPRESS", "OCS_WORLDWIDE", "DESTINY", "ARK_LOGISTICS", "DE_DPD_DELISTRACK", "COMET_TECH", "DHL_PARCEL_RU", "AQUILINE", "PILOT_FREIGHT", "TNT_REFR", "QWINTRY", "DANSKE_FRAGT", "SHREE_ANJANI_COURIER", "CARRIERS", "AIR_CANADA_GLOBAL", "PRESIDENT_TRANS", "STEPFORWARDFS", "ESHIPPING", "SHREETIRUPATI", "HX_EXPRESS", "INDOPAKET", "CN_17POST", "K1_EXPRESS", "CJ_GLS", "MYS_GDEX", "NATIONEX", "CN_EQUICK", "ANJUN", "VIRTRANSPORT", "FARGOOD", "SMG_EXPRESS", "RZYEXPRESS", "SEFL", "HIPSHIPPER", "HDB", "RPXLOGISTICS", "MIKROPAKKET_BE", "KUEHNE", "IT_NEXIVE", "PTS", "ETS_EXPRESS", "SWISS_POST_FTP", "COLIS_PRIVE", "FASTRK_SERV", "4_72", "US_YRC", "CN_YUNDA", "POSTNL_INTL_3S", "AAA_COOPER", "ELIAN_POST", "CUBYN", "SAU_SAUDI_POST", "360LION", "ABXEXPRESS_MY", "NINJAVAN_WB", "ESP_PACKLINK", "IND_JAYONEXPRESS", "GB_ARROW", "ZES_EXPRESS", "IND_GOJAVAS", "ZEPTO_EXPRESS", "SKYNET_ZA", "KPOST", "ZEEK_2_DOOR", "DHL_FREIGHT", "BLUECARE", "BLINKLASTMILE", "POSTA_UKR", "LOGISTYX_TRANSGROUP", "JINDOUYUN", "CHROBINSON", "TRACKON", "CN_POST56", "GB_TUFFNELLS", "COURANT_PLUS", "SCUDEX_EXPRESS", "SHIPENTEGRA", "TRUMPCARD", "CHOIR_EXP", "ETOTAL", "COPE", "SFPLUS_WEBHOOK", "IND_GATI", "HERMES_2MANN_HANDLING", "CN_WISHPOST", "GLOBALTRANZ", "HKD", "UDS", "BJSHOMEDELIVERY", "YAKIT", "LEXSHIP", "OMNIVA", "SUTTON", "COSTMETICSNOW", "PANTHER_REFERENCE", "SFCSERVICE", "PFLOGISTICS", "LTL", "LOOMIS_EXPRESS", "PARKNPARCEL", "SPRING_GDS", "GLS_ITALY", "ECEXPRESS", "LINE", "INTERPARCEL_AU", "GEL_EXPRESS", "AGILITY", "XL_EXPRESS", "ADERONLINE", "DIRECTCOURIERS", "PLANZER", "NOX_NIGHT_TIME_EXPRESS", "SENDING", "HUODULL"^[0-9A-Z_]+$The name of the shipment carrier for the transaction for this dispute.
carrier_name_otherstring^.*$The name of carrier in free-form text for unavailable carriers. This field is mandatory when carrier_name is OTHER.
tracking_urlstringuriThe URL to track the dispute-related transaction shipment.
tracking_numberrequiredstring^.*$The number to track the dispute-related transaction shipment.
refund_idsarrayAn array of refund IDs for the transaction involved in this dispute.
itemsstringThe ID of the refunded transaction.
documentsarrayAn array of evidence documents.
itemsobjectAn uploaded document as a binary object that supports a dispute.
namestring^[A-Za-z0-9-_,\s]+[.]{1}[A-Za-z]+$The document name.
urlstringuriThe downloadable URL for the document for which the client has access.
Note: Document download may require some configuration setup and available as a limited release at this time. For more information, reach out to your PayPal account manager..
notesstring^(.|\r?\n)*$Any evidence-related notes.
sourcestring"REQUESTED_FROM_BUYER", "REQUESTED_FROM_SELLER", "SUBMITTED_BY_BUYER", "SUBMITTED_BY_SELLER", "SUBMITTED_BY_PARTNER"^[A-Z_]+$The source of the evidence.
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 when the evidence was received, in Internet date and time format.
item_idstring^[A-Za-z0-9]+$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_typestring"PRODUCT", "SERVICE", "BOOKING", "DIGITAL_DOWNLOAD"^[0-9A-Z_]+$The item type for which the evidence is requested or submitted.
action_infoobjectThe 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.
actionstring"ACKNOWLEDGE_RETURN_ITEM", "ACCEPT_CLAIM", "PROVIDE_EVIDENCE", "APPEAL", "CANCEL", "CHANGE_REASON", "ESCALATE"^[A-Z_]+$The action for which the evidence was requested or submitted.
response_optionstring^[A-Z_]+$The response option for the corresponding action. Possible values:
.mandatorybooleanIndicates whether the evidence is mandatory for the corresponding action and response option.
dispute_life_cycle_stagestring"INQUIRY", "CHARGEBACK", "PRE_ARBITRATION", "ARBITRATION"^[0-9A-Z_]+$The dispute life cycle stage for the evidence.
buyer_response_due_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 by when the customer must respond to the dispute, in Internet date and time format. If the customer does not respond by this date and time, the dispute is closed in the merchant's favor. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
seller_response_due_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 by when the merchant must respond to the dispute, in Internet date and time format. If the merchant does not respond by this date and time, the dispute is closed in the customer's favor. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
offerobjectThe merchant-proposed offer for a dispute.
buyer_requested_amountobjectThe customer-requested refund for this 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.seller_offered_amountobjectThe merchant-offered refund for this 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.offer_typestring"REFUND", "REFUND_WITH_RETURN", "REFUND_WITH_REPLACEMENT", "REPLACEMENT_WITHOUT_REFUND"^[0-9A-Z_]+$The merchant-proposed offer type for the dispute.
historyarrayAn array of history information for an offer.
itemsobjectThe offer history.
offer_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 event occurred, in Internet date and time format.
actorstring"BUYER", "SELLER"^[0-9A-Z_]+$The event-related actor.
event_typestring"PROPOSED", "ACCEPTED", "DENIED"^[0-9A-Z_]+$The type of the history event.
offer_typestring"REFUND", "REFUND_WITH_RETURN", "REFUND_WITH_REPLACEMENT", "REPLACEMENT_WITHOUT_REFUND"^[0-9A-Z_]+$The merchant-proposed offer type for the dispute.
offer_amountobjectThe offer amount.
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)*$The user submitted notes.
dispute_life_cycle_stagestring"INQUIRY", "CHARGEBACK", "PRE_ARBITRATION", "ARBITRATION"^[0-9A-Z_]+$The dispute life cycle stage during the offer event.
refund_detailsobjectThe refund details.
allowed_refund_amountobjectThe maximum refundable amount.
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.transactionsarrayAn array of refund transactions associated with the dispute.
itemsobjectThe refund transaction details.
idstring^[A-Za-z0-9]+$The ID of the transaction for the refund or recovery.
gross_amountobjectThe gross amount of the refund.
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.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 of the refund in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.
communication_detailsobjectThe contact details that a merchant provides to the customer to use to share their evidence documents.
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 that is provided by the merchant where the customer can share the evidences.
notestring^(.|\r?\n)*$The merchant provided notes that are visible to both the customer and PayPal.
time_postedstringppaas_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 contact details were posted, in Internet date and time format.
supporting_infoarrayAn array of all the supporting information that are associated to this dispute.
itemsobjectA merchant- or customer-submitted supporting information.
notesstring^(.|\r?\n)*$Any supporting notes.
documentsarrayAn array of metadata for the documents which were uploaded as supporting information for the dispute.
itemsobjectAn uploaded document as a binary object that supports a dispute.
namestring^[A-Za-z0-9-_,\s]+[.]{1}[A-Za-z]+$The document name.
urlstringuriThe downloadable URL for the document for which the client has access.
Note: Document download may require some configuration setup and available as a limited release at this time. For more information, reach out to your PayPal account manager..
sourcestring"SUBMITTED_BY_BUYER", "SUBMITTED_BY_SELLER", "SUBMITTED_BY_PARTNER"^[0-9A-Z_]+$The source of the Information.
provided_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 information was received, in Internet date and time format.
dispute_life_cycle_stagestring"INQUIRY", "CHARGEBACK", "PRE_ARBITRATION", "ARBITRATION"^[0-9A-Z_]+$The dispute life cycle stage for the supporting info.
allowed_response_optionsobjectThe allowed response options for the buyer/seller update actions.
acknowledge_return_itemobjectThe allowed response options when the seller acknowledges that the buyer has returned an item for the dispute.
acknowledgement_typesarrayThe types of response when the merchant acknowledges a returned item.
itemsstring"ITEM_RECEIVED", "ITEM_NOT_RECEIVED", "DAMAGED", "EMPTY_PACKAGE_OR_DIFFERENT", "MISSING_ITEMS"^[0-9A-Z_]+$The type of acknowledgement allowed for the merchant after the customer has returned the item. The merchant can update whether the item was received and is as expected or if the item was not received.
accept_claimobjectThe allowed response options when the merchant is accepting the claim.
accept_claim_typesarrayThe types of refund the merchant can provide the customer.
itemsstring"REFUND", "REFUND_WITH_RETURN", "PARTIAL_REFUND", "REFUND_WITH_RETURN_SHIPMENT_LABEL"^[0-9A-Z_]+$The refund type proposed by the merchant for the dispute.
make_offerobjectThe allowed response options when the merchant makes offer to the customer.
offer_typesarrayThe types of offer the merchant can offer the customer.
itemsstring"REFUND", "REFUND_WITH_RETURN", "REFUND_WITH_REPLACEMENT", "REPLACEMENT_WITHOUT_REFUND"^[0-9A-Z_]+$The merchant-proposed offer type for the dispute.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^[\S\s]*$The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstring^[\S\s]*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"^[\S\s]*$The HTTP method required to make the related call.
titlestring^[\S\s]*$The link title.
mediaTypestring^[\S\s]*$The media type, as defined by RFC 2046. Describes the link target.
encTypestring^[\S\s]*$"application/json"The media type in which to submit the request data.
schemaobjectThe schema that describes the request data.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
targetSchemaobjectThe schema that describes the link target.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.